Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Merge pull request #12 from actions/release-procedure
Update release procedure
  • Loading branch information
James M. Greene authored and GitHub committed Aug 10, 2022
2 parents f422a5a + 724b943 commit 6a57e48
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions README.md
@@ -1,6 +1,6 @@
# upload-pages-artifact

A composite action for packaging and uploading artifact that can be deployed to [GitHub Pages][pages].
A composite Action for packaging and uploading artifact that can be deployed to [GitHub Pages][pages].

# Scope

Expand Down Expand Up @@ -30,26 +30,23 @@ The [`tar` file][tar] must:

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

The scripts and documentation in this project are released under the [MIT License](LICENSE).

<!-- references -->
[pages]: https://pages.github.com
[release-list]: /releases
[draft-release]: .github/workflows/draft-release.yml
[release]: .github/workflows/release.yml
[release-workflow-runs]: /actions/workflows/release.yml
[gzip]: https://en.wikipedia.org/wiki/Gzip
[tar]: https://en.wikipedia.org/wiki/Tar_(computing)

0 comments on commit 6a57e48

Please sign in to comment.