From a66ed7ceb05be4db2871f867db0381222ef1c436 Mon Sep 17 00:00:00 2001 From: "Jason C. Nucciarone" Date: Wed, 29 May 2024 13:51:52 -0400 Subject: [PATCH 1/4] docs: Revise `bot-email` and `bot-name` descriptions Signed-off-by: Jason C. Nucciarone --- get-screenshots/README.md | 4 ++-- release-to-candidate/README.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/get-screenshots/README.md b/get-screenshots/README.md index 7badab6..83ab693 100644 --- a/get-screenshots/README.md +++ b/get-screenshots/README.md @@ -29,8 +29,8 @@ jobs: | Key | Description | Required | Default | | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- | :------: | :---------------------------- | -| `bot-email` | The email address of the bot account used to commit screenshots. | N | `snapforge.team@gmail.com` | -| `bot-name` | The name of the bot account used to commit screenshots.. | N | `Snapcrafters Bot` | +| `bot-email` | The email address of the bot account to use to commit screenshots. | N | `snapforge.team@gmail.com` | +| `bot-name` | The name of the bot account to use to commit screenshots.. | N | `Snapcrafters Bot` | | `issue-number` | The issue number to post the screenshots to. | Y | | | `ci-repo` | The repo to fetch tools/templates from. Only for debugging. | N | `snapcrafters/ci` | | `channel` | The channel to create the call for testing for. | N | `latest/candidate` | diff --git a/release-to-candidate/README.md b/release-to-candidate/README.md index 96741e8..b1aa42d 100644 --- a/release-to-candidate/README.md +++ b/release-to-candidate/README.md @@ -27,8 +27,8 @@ jobs: | Key | Description | Required | Default | | ------------------------ | ----------------------------------------------------------------------------------------- | :------: | :------------------------- | | `architecture` | The architecture for which to build the snap. | N | `amd64` | -| `bot-email` | The email address of the bot account used to commit screenshots. | N | `snapforge.team@gmail.com` | -| `bot-name` | The name of the bot account used to commit screenshots.. | N | `Snapcrafters Bot` | +| `bot-email` | The email address of the bot account to use to create and push tags to the repository. | N | `snapforge.team@gmail.com` | +| `bot-name` | The name of the bot account to use to create and push tags to the repository. | N | `Snapcrafters Bot` | | `channel` | The channel to release the snap to. | N | `latest/candidate` | | `launchpad-token` | A token with permissions to create Launchpad remote builds. | Y | | | `multi-snap` | Whether the repo contains the source for multiple snaps. | N | `false` | From fc667dcd17379cbb4b9ade0956528bb2fd26a2aa Mon Sep 17 00:00:00 2001 From: "Jason C. Nucciarone" Date: Wed, 29 May 2024 13:57:51 -0400 Subject: [PATCH 2/4] chore(fmt): Apply formatting standards to README Signed-off-by: Jason C. Nucciarone --- get-screenshots/README.md | 4 ++-- release-to-candidate/README.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/get-screenshots/README.md b/get-screenshots/README.md index 83ab693..086a948 100644 --- a/get-screenshots/README.md +++ b/get-screenshots/README.md @@ -29,8 +29,8 @@ jobs: | Key | Description | Required | Default | | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- | :------: | :---------------------------- | -| `bot-email` | The email address of the bot account to use to commit screenshots. | N | `snapforge.team@gmail.com` | -| `bot-name` | The name of the bot account to use to commit screenshots.. | N | `Snapcrafters Bot` | +| `bot-email` | The email address of the bot account to use to commit screenshots. | N | `snapforge.team@gmail.com` | +| `bot-name` | The name of the bot account to use to commit screenshots.. | N | `Snapcrafters Bot` | | `issue-number` | The issue number to post the screenshots to. | Y | | | `ci-repo` | The repo to fetch tools/templates from. Only for debugging. | N | `snapcrafters/ci` | | `channel` | The channel to create the call for testing for. | N | `latest/candidate` | diff --git a/release-to-candidate/README.md b/release-to-candidate/README.md index b1aa42d..78cea3b 100644 --- a/release-to-candidate/README.md +++ b/release-to-candidate/README.md @@ -27,8 +27,8 @@ jobs: | Key | Description | Required | Default | | ------------------------ | ----------------------------------------------------------------------------------------- | :------: | :------------------------- | | `architecture` | The architecture for which to build the snap. | N | `amd64` | -| `bot-email` | The email address of the bot account to use to create and push tags to the repository. | N | `snapforge.team@gmail.com` | -| `bot-name` | The name of the bot account to use to create and push tags to the repository. | N | `Snapcrafters Bot` | +| `bot-email` | The email address of the bot account to use to create and push tags to the repository. | N | `snapforge.team@gmail.com` | +| `bot-name` | The name of the bot account to use to create and push tags to the repository. | N | `Snapcrafters Bot` | | `channel` | The channel to release the snap to. | N | `latest/candidate` | | `launchpad-token` | A token with permissions to create Launchpad remote builds. | Y | | | `multi-snap` | Whether the repo contains the source for multiple snaps. | N | `false` | From c1b8b3e21a1151063e0becc3ddc9726067f72d05 Mon Sep 17 00:00:00 2001 From: Jon Seager Date: Wed, 29 May 2024 19:05:29 +0100 Subject: [PATCH 3/4] Update get-screenshots/README.md --- get-screenshots/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/get-screenshots/README.md b/get-screenshots/README.md index 086a948..7d1bdd6 100644 --- a/get-screenshots/README.md +++ b/get-screenshots/README.md @@ -30,7 +30,7 @@ jobs: | Key | Description | Required | Default | | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- | :------: | :---------------------------- | | `bot-email` | The email address of the bot account to use to commit screenshots. | N | `snapforge.team@gmail.com` | -| `bot-name` | The name of the bot account to use to commit screenshots.. | N | `Snapcrafters Bot` | +| `bot-name` | The name of the bot account to use to commit screenshots. | N | `Snapcrafters Bot` | | `issue-number` | The issue number to post the screenshots to. | Y | | | `ci-repo` | The repo to fetch tools/templates from. Only for debugging. | N | `snapcrafters/ci` | | `channel` | The channel to create the call for testing for. | N | `latest/candidate` | From a133cb085b573926d4afd2ce08f19fb5957c71b1 Mon Sep 17 00:00:00 2001 From: Jon Seager Date: Wed, 29 May 2024 19:06:25 +0100 Subject: [PATCH 4/4] fix formatting --- get-screenshots/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/get-screenshots/README.md b/get-screenshots/README.md index 7d1bdd6..287d862 100644 --- a/get-screenshots/README.md +++ b/get-screenshots/README.md @@ -30,7 +30,7 @@ jobs: | Key | Description | Required | Default | | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- | :------: | :---------------------------- | | `bot-email` | The email address of the bot account to use to commit screenshots. | N | `snapforge.team@gmail.com` | -| `bot-name` | The name of the bot account to use to commit screenshots. | N | `Snapcrafters Bot` | +| `bot-name` | The name of the bot account to use to commit screenshots. | N | `Snapcrafters Bot` | | `issue-number` | The issue number to post the screenshots to. | Y | | | `ci-repo` | The repo to fetch tools/templates from. Only for debugging. | N | `snapcrafters/ci` | | `channel` | The channel to create the call for testing for. | N | `latest/candidate` |