From 858592354e8a53de682fd799c179271e31091945 Mon Sep 17 00:00:00 2001
From: Yoann Chaudet <yoannchaudet@github.com>
Date: Wed, 24 Aug 2022 10:53:23 -0700
Subject: [PATCH] Add release instructions

---
 .github/release-drafter.yml | 46 +++++++++++++++++++------------------
 README.md                   | 11 +++++++++
 2 files changed, 35 insertions(+), 22 deletions(-)

diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml
index 8c89499..2735ea1 100644
--- a/.github/release-drafter.yml
+++ b/.github/release-drafter.yml
@@ -1,38 +1,40 @@
 ---
-name-template: 'v$RESOLVED_VERSION'
-tag-template: 'v$RESOLVED_VERSION'
+name-template: "v$RESOLVED_VERSION"
+tag-template: "v$RESOLVED_VERSION"
 template: |
   # Changelog
+
   $CHANGES
-  See details of [all code changes](https://github.com/actions/deploy-pages/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION) since previous release
+
+  See details of [all code changes](https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION) since previous release.
 categories:
-  - title: '🚀 Features'
+  - title: "🚀 Features"
     labels:
-      - 'feature'
-      - 'enhancement'
-  - title: '🐛 Bug Fixes'
+      - "feature"
+      - "enhancement"
+  - title: "🐛 Bug Fixes"
     labels:
-      - 'fix'
-      - 'bugfix'
-      - 'bug'
-  - title: '🧰 Maintenance'
+      - "fix"
+      - "bugfix"
+      - "bug"
+  - title: "🧰 Maintenance"
     labels:
-      - 'infrastructure'
-      - 'automation'
-      - 'documentation'
-  - title: '🏎 Performance'
-    label: 'performance'
-change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+      - "infrastructure"
+      - "automation"
+      - "documentation"
+  - title: "🏎 Performance"
+    label: "performance"
+change-template: "- $TITLE @$AUTHOR (#$NUMBER)"
 version-resolver:
   major:
     labels:
-      - 'type: breaking'
+      - "type: breaking"
   minor:
     labels:
-      - 'type: enhancement'
+      - "type: enhancement"
   patch:
     labels:
-      - 'type: bug'
-      - 'type: maintenance'
-      - 'type: documentation'
+      - "type: bug"
+      - "type: maintenance"
+      - "type: documentation"
   default: patch
diff --git a/README.md b/README.md
index 0532224..4556d93 100644
--- a/README.md
+++ b/README.md
@@ -62,6 +62,16 @@ There are a few important considerations to be aware of:
 
 5. If your Pages site is using GitHub Actions as the source, while not required we highly recommend you also [protect your environment][environment-protection] (we do it by default for you)
 
+# Release instructions
+
+In order to release a new version of this Action:
+
+1. 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:
+
+2. After publishing the release, the [`release` workflow][release] will automatically run to create/update the corresponding the major version tag such as `v0`.
+
+   ⚠️ 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).
@@ -71,3 +81,4 @@ The scripts and documentation in this project are released under the [MIT Licens
 [upload-pages-artifact]: https://github.com/actions/upload-pages-artifact
 [artifacts]: https://docs.github.com/en/actions/using-workflows/storing-workflow-data-as-artifacts
 [environment-protection]: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules
+[release-workflow-runs]: https://github.com/actions/deploy-pages/actions/workflows/release.yml
\ No newline at end of file