Skip to content

Commit

Permalink
Move the release docs to a separate folder/file
Browse files Browse the repository at this point in the history
  • Loading branch information
frankkopp committed Nov 18, 2024
1 parent 75a2d80 commit 0de693b
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 19 deletions.
19 changes: 0 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,22 +40,3 @@ npm run package
Packaged applications will automatically update if there is a newer version available (compared to build version in package.json), this does
also apply to development versions (ending on -devXX), which are updated via a separate stream. Updates are distributed once the build
version is changed and a tag has been added.

## How to build a Release

- 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`)
20 changes: 20 additions & 0 deletions docs/release-docs.md
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`)

0 comments on commit 0de693b

Please sign in to comment.