From 8441c1b1dca0fb58056d580d259afad9c671427b Mon Sep 17 00:00:00 2001 From: "James M. Greene" Date: Fri, 5 Aug 2022 15:29:09 -0500 Subject: [PATCH 1/3] Improve a few contribution notes in the README --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 68e6d4d..6c0e08f 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ An action to enable Pages and extract various metadata about a site. It can also be used to configure various static site generators we support as [starter workflows][starter-workflows]. -See [`set-pages-path.js`](./src/set-pages-path.js) for more details on how we configure static site generators to work "out of the box" with GitHub Pages. +See [`set-pages-path.js`](src/set-pages-path.js) for more details on how we configure static site generators to work "out of the box" with GitHub Pages. # Usage @@ -12,9 +12,9 @@ See [action.yml](action.yml) and the [Pages starter workflows][starter-workflows In order to release a new version of this Action: -1. Locate the semantic version of the upcoming release (a draft is maintained by the [`draft-release` workflow][draft-release]) +1. Locate the semantic version of the [upcoming release][release-list] (a draft is maintained by the [`draft-release` workflow][draft-release]) -2. Push a matching tag, for instance for `v0.1.0`: +2. Push a matching tag (e.g.`v0.1.0`) **if** different than the `main` branch (if not, publishing the draft release will create it): ```bash git tag v0.1.0 @@ -23,7 +23,7 @@ In order to release a new version of this Action: 3. Publish the draft release (the major tag such as `v0` will be created/updated by the [`release` workflow][release]) - ⚠️ Environment approval is required. + ⚠️ Environment approval is required. Check the [Release workflow run list][release-workflow-runs]. # License @@ -31,5 +31,7 @@ The scripts and documentation in this project are released under the [MIT Licens [starter-workflows]: https://github.com/actions/starter-workflows/tree/main/pages +[release-list]: /releases [draft-release]: .github/workflows/draft-release.yml -[release]: .github/workflows/release.yml \ No newline at end of file +[release]: .github/workflows/release.yml +[release-workflow-runs]: /actions/workflows/release.yml From 9f6ed02477fcc659e81bf44e3b4499914c2d4565 Mon Sep 17 00:00:00 2001 From: "James M. Greene" Date: Mon, 8 Aug 2022 11:15:41 -0500 Subject: [PATCH 2/3] Tweak the title and description in README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6c0e08f..4d4df3c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Configure-Pages +# configure-pages -An action to enable Pages and extract various metadata about a site. It can also be used to configure various static site generators we support as [starter workflows][starter-workflows]. +A GitHub Action to enable Pages and extract various metadata about a site. It can also be used to configure various static site generators we support as [starter workflows][starter-workflows]. See [`set-pages-path.js`](src/set-pages-path.js) for more details on how we configure static site generators to work "out of the box" with GitHub Pages. From 491169de17a09e039a8f99afa3c161fae6d45b63 Mon Sep 17 00:00:00 2001 From: "James M. Greene" Date: Wed, 10 Aug 2022 14:10:15 -0500 Subject: [PATCH 3/3] Revise release procedure --- README.md | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 4d4df3c..226d4d2 100644 --- a/README.md +++ b/README.md @@ -12,16 +12,11 @@ See [action.yml](action.yml) and the [Pages starter workflows][starter-workflows In order to release a new version of this Action: -1. Locate the semantic version of the [upcoming release][release-list] (a draft is maintained by the [`draft-release` workflow][draft-release]) +1. Locate the semantic version of the [upcoming release][release-list] (a draft is maintained by the [`draft-release` workflow][draft-release]). -2. Push a matching tag (e.g.`v0.1.0`) **if** different than the `main` branch (if not, publishing the draft release will create it): +2. Publish the draft release from the `main` branch with semantic version as the tag name, _with_ the checkbox to publish to the GitHub Marketplace checked. :ballot_box_with_check: - ```bash - git tag v0.1.0 - git push origin v0.1.0 - ``` - -3. Publish the draft release (the major tag such as `v0` will be created/updated by the [`release` workflow][release]) +3. After publishing the release, the [`release` workflow][release] will automatically run to create/update the corresponding the major version tag such as `v0`. ⚠️ Environment approval is required. Check the [Release workflow run list][release-workflow-runs].