You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+21-14Lines changed: 21 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,20 +67,27 @@ If you encounter a bug or have a feature request, please [open an issue][github-
67
67
68
68
The release process is automated. Follow the steps below.
69
69
70
-
1. Verify that all features you want targeted in the release have been merged to `main`.
71
-
2. Check the [Renovate Dependency Dashboard][github-dependency-dashboard] to see if there are any updates you want included.
72
-
3. Create a [new **draft** release][github-new-release]. Set the tag version to something with the format of `v1.2.3`. Save as a **draft** before moving to the next step
73
-
4. Create a branch that starts with `release/vX.X.X` (ie. `release/v1.2.3`). In this branch you need to:
74
-
* Run `pnpm version <new-version-number` to **bump the version** of the app .
75
-
* Commit these changes and open a PR. A GitHub Actions workflow will build, sign and upload the release assets for each commit to that branch as long as a branch is named like `release/vX.X.X` and there is a draft release with the same version number(`package.json`).
76
-
5. Merge your release branch into `main`.
77
-
6. Publish the release once you've finalized the release notes and confirmed all assets are there.
78
-
7. Edit current [Milestone][github-milestones] to have:
79
-
* description: link to the release notes
80
-
* due date: date of release
81
-
* close milestone
82
-
8. Create a [New Milestone][github-new-milestone] for upcoming release.
83
-
9. A new homebrew cask will be [automatically published][homebrew-cask-autobump-workflow] (workflow runs ~3 hours)
70
+
1.**Verify features:** Ensure all features and fixes you want included in the release are merged into `main`.
71
+
2.**Check dependencies:** Review the [Renovate Dependency Dashboard][github-dependency-dashboard] for any dependency updates you want to include.
72
+
3.**Create a release branch:**
73
+
- Name your branch `release/vX.X.X` (e.g., `release/v1.2.3`).
74
+
- Run `pnpm version <new-version-number>` to **bump the version** in `package.json` and create a version commit/tag.
75
+
- Update `sonar.projectVersion` within `sonar-project.properties`
76
+
- Commit and push these changes.
77
+
- Open a Pull Request (PR) from your release branch.
78
+
4.**GitHub release:** GitHub Actions will automatically build, sign, and upload release assets to a new draft release with automated release notes.
79
+
5.**Merge the release branch:** Once the PR is approved and checks pass, merge your release branch into `main`.
80
+
6.**Publish the release:**
81
+
- Finalize the release notes in the draft release on GitHub.
82
+
- Confirm all assets are present and correct.
83
+
- Publish the release.
84
+
7.**Update milestones:**
85
+
- Edit the current [Milestone][github-milestones]:
86
+
- Add a link to the release notes in the description.
87
+
- Set the due date to the release date.
88
+
- Close the milestone.
89
+
- Create a [New Milestone][github-new-milestone] for the next release cycle.
90
+
8. A new homebrew cask will be [automatically published][homebrew-cask-autobump-workflow] (workflow runs ~3 hours)
0 commit comments