Skip to content

There can be more than Notion and Miro. AFFiNE(pronounced [ə‘fain]) is a next-gen knowledge base that brings planning, sorting and creating all together. Privacy first, open-source, customizable and ready to use.

docs: format releases.md

LongYinan5bb67e66c2a6
diff --git a/docs/contributing/releases.md b/docs/contributing/releases.md
index 3dca73c5e0..c805447637 100644
--- a/docs/contributing/releases.md
+++ b/docs/contributing/releases.md
@@ -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.
-## 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.
-- Access to GitHub Actions.
+- Commit access to the AFFiNE repository.
+- 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
./scripts/set-version.sh 0.5.4-canary.5
```
-### 2. Commit Changes and Push to `canary`
+### 2. Commit Changes and Push to `canary`
```shell
git add .
@@ -28,20 +28,21 @@ git commit -m "v0.5.4-canary.5"
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:
-- The release tag and title match the version in `package.json`.
+Ensure that:
+
+- The release tag and title match the version in `package.json`.
- The release targets the commit you just pushed.