Files
AFFiNE-Mirror/docs/contributing/releases.md
2025-04-15 11:37:39 +08:00

1.4 KiB

AFFiNE Release Process

In order to make a stable/beta release, you need to get authorization from the AFFiNE test team.

Who Can Make a Release?

The AFFiNE core team grants release authorization and enforces the following requirements:

  • Commit access to the AFFiNE repository.
  • Access to GitHub Actions.

How to Make a Release

Before releasing, ensure you have the latest version of the canary branch and review the SemVer specification to understand versioning.

1. Update the Version in package.json

./scripts/set-version.sh 0.5.4-canary.5

2. Commit Changes and Push to canary

git add .
# vX.Y.Z-canary.N
git commit -m "v0.5.4-canary.5"
git push origin canary

3. Create a Release Action

Trigger a release action in the Release Desktop App.

img.png

Select the appropriate branch, complete the form, and click Run workflow.

4. Publish the Release

Once the release action is complete, a draft release will appear on the Releases page.

Edit the release notes if necessary, then publish the release.

Ensure that:

  • The release tag and title match the version in package.json.
  • The release targets the commit you just pushed.