Merge pull request #3 from paper-spa/release

Document release + add codeowners
actions · May 24, 2022 · 5abd6d2 · 5abd6d2
2 parents 4feee6a + 2c3f8ae
commit 5abd6d2
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1 @@
+* @paper-spa/pages
diff --git a/README.md b/README.md
@@ -12,9 +12,28 @@ See [action.yml](action.yml)
 
 <!-- TODO: document custom workflow -->
 
+# 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).
 
 <!-- references -->
 [pages]: https://pages.github.com
+[draft-release]: .github/workflows/draft-release.yml
+[release]: .github/workflows/release.yml