diff --git a/README.md b/README.md index d672d00..4ab9d32 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,13 @@ An action to enable Pages and extract various metadata about a site. It can also # Usage -See [action.yml](action.yml) +See [action.yml](action.yml) and the [Pages starter workflows][starter-workflows]. # Release instructions 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.yml)) +1. Locate the semantic version of the upcoming release (a draft is maintained by the [`draft-release` workflow][draft-release]) 2. Push a matching tag, for instance for `v0.1.0`: @@ -19,7 +19,7 @@ In order to release a new version of this Action: 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.yml)) +3. Publish the draft release (the major tag such as `v0` will be created/updated by the [`release` workflow][release]) ⚠️ Environment approval is required. @@ -28,4 +28,6 @@ In order to release a new version of this Action: The scripts and documentation in this project are released under the [MIT License](LICENSE). -[starter-workflows]: https://github.com/actions/starter-workflows/tree/main/pages \ No newline at end of file +[starter-workflows]: https://github.com/actions/starter-workflows/tree/main/pages +[draft-release]: .github/workflows/draft-release.yml +[release]: .github/workflows/release.yml \ No newline at end of file