From 1e771131b052875622ccfc08909a15d5d27b37b9 Mon Sep 17 00:00:00 2001 From: himself65 Date: Thu, 20 Apr 2023 11:32:17 -0500 Subject: [PATCH] docs: format `releases.md` --- docs/contributing/releases.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/contributing/releases.md b/docs/contributing/releases.md index 295525535..97377dbc2 100644 --- a/docs/contributing/releases.md +++ b/docs/contributing/releases.md @@ -13,13 +13,13 @@ Before releasing, ensure you have the latest version of the `master` branch. 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 yarn workspaces foreach exec yarn version 0.5.4-canary.5 ``` -### 2. Commit changes and push to `master.` +### 2. Commit changes and push to `master` ```shel git add . @@ -30,11 +30,11 @@ git push origin master ### 3. Create a release action -Create a release action in the [AFFiNE repository](https://github.com/toeverything/AFFiNE/actions/workflows/release-desktop-app.yml). +Create 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) -Select the correct branch and fill out the form, then click `Run workflow.` +Select the correct branch and fill out the form, then click `Run workflow`. ### 4. Publish the release @@ -42,6 +42,6 @@ After the release action is completed, you can see the draft release on the [rel You can edit the release note and publish it. -Remember that the release tag and title should be the same as the version in `package.json.` +Remember that the release tag and title should be the same as the version in `package.json`. And target the release to that commit you just pushed.