From 12344c123e475be086c04ce3e387b6db22e2bfb1 Mon Sep 17 00:00:00 2001 From: Jeremiah Russell Date: Mon, 20 Oct 2025 07:31:18 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs(readme):=20move=20integrati?= =?UTF-8?q?on=20test=20instructions=20to=20docs/readme/head.md=20per=20rel?= =?UTF-8?q?ease=20process?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 16 ---------------- docs/readme/head.md | 16 ++++++++++++++++ 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 551a3d7..5a0b533 100644 --- a/README.md +++ b/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 ## 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: - login to get authorization diff --git a/docs/readme/head.md b/docs/readme/head.md index 1815f3b..b943ba6 100644 --- a/docs/readme/head.md +++ b/docs/readme/head.md @@ -37,4 +37,20 @@ The `cull-gmail` provides a software library and command line program to enable - run the rules list be default - 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.