From 783c99214f49e8663738d96e59ad3212d10dee58 Mon Sep 17 00:00:00 2001 From: Yoann Chaudet Date: Tue, 24 May 2022 15:20:30 -0700 Subject: [PATCH] Document release + add codeowners --- .github/CODEOWNERS | 1 + README.md | 19 +++++++++++++++++++ 2 files changed, 20 insertions(+) create mode 100644 .github/CODEOWNERS diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..ad7a823 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @paper-spa/pages \ No newline at end of file diff --git a/README.md b/README.md index 57310d1..cfa656a 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,28 @@ See [action.yml](action.yml) +# 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]) + +2. Push a matching tag, for instance for `v0.1.0`: + + ```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]) + + ⚠️ Environment approval is required. + # License The scripts and documentation in this project are released under the [MIT License](LICENSE). [pages]: https://pages.github.com +[draft-release]: .github/workflows/draft-release.yml +[release]: .github/workflows/release.yml \ No newline at end of file