Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: improve grammar of contributing releases.md #10032

Open
wants to merge 1 commit into
base: canary
Choose a base branch
from
Open

fix: improve grammar of contributing releases.md #10032

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 20 additions & 22 deletions docs/contributing/releases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,49 +1,47 @@
## 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 gives release authorization. And also have the following requirements.
The AFFiNE core team grants release authorization and enforces the following requirements:

- Have commit access to the AFFiNE repository.
- Have 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.
Before releasing, ensure you have the latest version of the `canary` branch and review the [SemVer](https://semver.org) specification to understand versioning.

And Read the semver specification to understand how to version your release. https://semver.org

### 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 .
# vx.y.z-canary.n
# vX.Y.Z-canary.N
git commit -m "v0.5.4-canary.5"
git push origin canary
```

### 3. Create a release action

Create a release action in the [Release Desktop App](https://github.com/toeverything/AFFiNE/actions/workflows/release-desktop-app.yml).
### 3. Create a Release Action

![img.png](assets/release-action.png)
Trigger a release action in the [Release Desktop App](https://github.com/toeverything/AFFiNE/actions/workflows/release-desktop-app.yml).

Select the correct branch and fill out the form, then click `Run workflow`.
![img.png](assets/release-action.png)

### 4. Publish the release
Select the appropriate branch, complete the form, and click `Run workflow`.

After the release action is completed, you can see the draft release on the [release page](https://github.com/toeverything/AFFiNE/releases).
### 4. Publish the Release

You can edit the release note and publish it.
Once the release action is complete, a draft release will appear on the [Releases page](https://github.com/toeverything/AFFiNE/releases).

Remember that the release tag and title should be the same as the version in `package.json`.
Edit the release notes if necessary, then publish the release.

And target the release to that commit you just pushed.
Ensure that:
- The release tag and title match the version in `package.json`.
- The release targets the commit you just pushed.