Jayden/AFFiNE-Mirror
1
0
Fork 0
mirror of https://github.com/toeverything/AFFiNE.git synced 2026-02-04 00:28:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: format releases.md

Browse Source
This commit is contained in:
LongYinan
2025-04-15 11:37:39 +08:00
parent 2b9ccf8fcf
commit 5bb67e66c2
1 changed files with 19 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
docs/contributing/releases.md
View File

@@ -1,25 +1,25 @@
## AFFiNE Release Process ## AFFiNE Release Process
> In order to make a stable/beta release, you need to get authorization from the AFFiNE test team. > In order to make a stable/beta release, you need to get authorization from the AFFiNE test team.
## Who Can Make a Release? ## Who Can Make a Release?
The AFFiNE core team grants release authorization and enforces the following requirements: The AFFiNE core team grants release authorization and enforces the following requirements:
- Commit access to the AFFiNE repository. - Commit access to the AFFiNE repository.
- Access to GitHub Actions. - Access to GitHub Actions.
## How to Make a Release ## How to Make a Release
Before releasing, ensure you have the latest version of the `canary` branch and review the [SemVer](https://semver.org) specification to understand versioning. Before releasing, ensure you have the latest version of the `canary` branch and review the [SemVer](https://semver.org) specification to understand versioning.
### 1. Update the Version in `package.json` ### 1. Update the Version in `package.json`
```shell ```shell
./scripts/set-version.sh 0.5.4-canary.5 ./scripts/set-version.sh 0.5.4-canary.5
``` ```
### 2. Commit Changes and Push to `canary` ### 2. Commit Changes and Push to `canary`
```shell ```shell
git add . git add .
@@ -28,20 +28,21 @@ git commit -m "v0.5.4-canary.5"
git push origin canary git push origin canary
``` ```
### 3. Create a Release Action ### 3. Create a Release Action
Trigger a release action in the [Release Desktop App](https://github.com/toeverything/AFFiNE/actions/workflows/release-desktop-app.yml). Trigger a release action in the [Release Desktop App](https://github.com/toeverything/AFFiNE/actions/workflows/release-desktop-app.yml).
![img.png](assets/release-action.png) ![img.png](assets/release-action.png)
Select the appropriate branch, complete the form, and click `Run workflow`. Select the appropriate branch, complete the form, and click `Run workflow`.
### 4. Publish the Release ### 4. Publish the Release
Once the release action is complete, a draft release will appear on the [Releases page](https://github.com/toeverything/AFFiNE/releases). Once the release action is complete, a draft release will appear on the [Releases page](https://github.com/toeverything/AFFiNE/releases).
Edit the release notes if necessary, then publish the release. Edit the release notes if necessary, then publish the release.
Ensure that: Ensure that:
- The release tag and title match the version in `package.json`.
- The release tag and title match the version in `package.json`.
- The release targets the commit you just pushed. - The release targets the commit you just pushed.