actions/configure-pages
1
0
Fork 0
mirror of https://github.com/actions/configure-pages.git synced 2025-12-08 08:06:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #12 from actions/better-docs

Browse Source 
Improve a few contribution notes in the README
This commit is contained in:
James M. Greene
2022-08-10 14:19:56 -05:00
committed by GitHub
parent f19391002a a220556ffe
commit c61e34fb27
1 changed files with 10 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -1,8 +1,8 @@
# 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.
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,18 +12,13 @@ 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. 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. After publishing the release, the [`release` workflow][release] will automatically run to create/update the corresponding the major version tag such as `v0`.
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 +26,7 @@ The scripts and documentation in this project are released under the [MIT Licens
<!-- references -->
[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
[release]: .github/workflows/release.yml
[release-workflow-runs]: /actions/workflows/release.yml