Skip to content

Commit c08fc87

Browse files
committed
readme update for release
Signed-off-by: Vedansh Saini <[email protected]>
1 parent 35750c8 commit c08fc87

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,30 @@ If you want to share your translation with others:
178178
For more details, see the [Chrome i18n documentation](https://developer.chrome.com/docs/extensions/reference/i18n/).
179179

180180

181+
## Release Process
182+
183+
This project uses a fully automated release process powered by GitHub Actions. Understanding this process is helpful for both maintainers and contributors.
184+
185+
The process is split into two parts:
186+
187+
### 1. Automated Release Drafting
188+
189+
This part runs every time a pull request is merged into the `master` branch.
190+
191+
1. **PR Merge**: A contributor's pull request is reviewed and merged.
192+
2. **Drafting Workflow**: The "Release Drafter" workflow is triggered.
193+
3. **Versioning**: The workflow inspects the `release:*` label or PR title to determine the next semantic version.
194+
4. **Changelog Update**: The `CHANGELOG.md` file is automatically updated with the titles of the merged PRs.
195+
5. **Draft Creation**: A new draft release is created or updated in the [Releases](https://github.com/fossasia/scrum-helper/releases) section. This draft includes the new version tag and the updated changelog notes.
196+
197+
### 2. Manual Release Publishing
198+
199+
This part is performed manually by maintainers when it's time to publish a new version.
200+
201+
1. **Verification**: A maintainer reviews the draft release to ensure it's accurate and complete.
202+
2. **Publishing**: The maintainer publishes the release from the GitHub UI.
203+
3. **Chrome Web Store Deployment**: Publishing the release triggers the "Publish to Chrome Web Store" workflow, which automatically packages the extension and uploads it for review.
204+
181205
## About contributing
182206

183207
- Follow the Issues and PRs templates as far as possible.

0 commit comments

Comments
 (0)