📝 docs(readme): move integration test instructions to docs/readme/head.md per release process
This commit is contained in:
committed by
Jeremiah Russell
parent
862f926bd5
commit
12344c123e
16
README.md
16
README.md
@@ -37,22 +37,6 @@ The `cull-gmail` provides a software library and command line program to enable
|
|||||||
- move email matching a filtered list to trash
|
- move email matching a filtered list to trash
|
||||||
## cull-gmail Library Documentation
|
## cull-gmail Library Documentation
|
||||||
|
|
||||||
### Running the optional Gmail integration test
|
|
||||||
|
|
||||||
An optional, ignored integration test exercises the Gmail API end-to-end (networked). It is ignored by default and will not run in CI.
|
|
||||||
|
|
||||||
Steps to run locally:
|
|
||||||
|
|
||||||
1. Ensure you have valid OAuth client credentials configured for the library (see `ClientConfig::builder()` usage in docs).
|
|
||||||
2. Run the test explicitly with the ignored flag:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cargo test --test gmail_message_list_integration -- --ignored
|
|
||||||
```
|
|
||||||
|
|
||||||
Notes:
|
|
||||||
- The test performs a lightweight listing (max 10 messages) and should be safe, but it still uses your Gmail account.
|
|
||||||
- Do not run this in CI; it is intended only for local verification.
|
|
||||||
|
|
||||||
The `cull-gmail` library provides types to enable the culling of emails using the Gmail API including the following steps:
|
The `cull-gmail` library provides types to enable the culling of emails using the Gmail API including the following steps:
|
||||||
- login to get authorization
|
- login to get authorization
|
||||||
|
|||||||
@@ -37,4 +37,20 @@ The `cull-gmail` provides a software library and command line program to enable
|
|||||||
- run the rules list be default
|
- run the rules list be default
|
||||||
- configure api client by file or environment variables
|
- configure api client by file or environment variables
|
||||||
|
|
||||||
|
### Running the optional Gmail integration test
|
||||||
|
|
||||||
|
An optional, ignored integration test exercises the Gmail API end-to-end (networked). It is ignored by default and will not run in CI.
|
||||||
|
|
||||||
|
Steps to run locally:
|
||||||
|
|
||||||
|
1. Ensure you have valid OAuth client credentials configured for the library (see `ClientConfig::builder()` usage in docs).
|
||||||
|
2. Run the test explicitly with the ignored flag:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cargo test --test gmail_message_list_integration -- --ignored
|
||||||
|
```
|
||||||
|
|
||||||
|
Notes:
|
||||||
|
- The test performs a lightweight listing (max 10 messages) and should be safe, but it still uses your Gmail account.
|
||||||
|
- Do not run this in CI; it is intended only for local verification.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user