actions/configure-pages
1
0
Fork 0
mirror of https://github.com/actions/configure-pages.git synced 2026-03-28 17:04:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve a few contribution notes in the README

Browse Source
This commit is contained in:
James M. Greene
2022-08-05 15:29:09 -05:00
parent e22fa7ebed
commit 8441c1b1dc
1 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -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]. 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 # 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: 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 ```bash
git tag v0.1.0 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]) 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 # License
@@ -31,5 +31,7 @@ The scripts and documentation in this project are released under the [MIT Licens
<!-- references --> <!-- references -->
[starter-workflows]: https://github.com/actions/starter-workflows/tree/main/pages [starter-workflows]: https://github.com/actions/starter-workflows/tree/main/pages
[release-list]: /releases
[draft-release]: .github/workflows/draft-release.yml [draft-release]: .github/workflows/draft-release.yml
[release]: .github/workflows/release.yml [release]: .github/workflows/release.yml
[release-workflow-runs]: /actions/workflows/release.yml