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

docs: added release build documentation #501

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: added release build documentation #501

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
75a2d80
Add release build docu
frankkopp Nov 17, 2024
0de693b
Move the release docs to a separate folder/file
frankkopp Nov 18, 2024
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
20 changes: 20 additions & 0 deletions docs/release-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# How to build a Release

Only relevant to repository maintainers.

- Make sure all PRs for the release are merged to the `master` branch
- For minor releases create a new branch on the repo from master (e.g. `v.3.4`)
- In the new release branch on your local machine:
- Cherry Pick all commits from the `master` branch you want included in the release
- Update the version (several places) in `package.json` and `package-lock.json`
- Create a Release Candidate for testing:
- Add a new tag with the version number (e.g. `v3.4.4-rc.1`)
- Push the commits and tag to the repo
- The CI will build the release candidate (because of the tag) and add it to the GitHub releases
- Test the release candidate
- If the release candidate is good
- Update the version (several places) in `package.json` and `package-lock.json`
- Create a new tag with the version number (e.g. `v3.4.4`)
- Push the commits and tag to the repo
- The CI will build the release and add it to the GitHub releases
- Bump the version in the `master` branch to the next version (e.g. `3.4.5-dev.1`)
Loading