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: add release guide #18

Merged
merged 1 commit into from
Jun 15, 2023
Merged

docs: add release guide #18

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
19 changes: 18 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,24 @@ This repository contains the web frontend for the ProvideQ toolbox.
You can disable the data collection using `yarn exec next telemetry disable`.
5. Use `yarn dev` to spin up a local development server

## Releasing a new version
1. Create a release branch from develop: `git checkout -b release/x.y.z`.
2. Bump the version number in the `package.json` file to the new version number
and commit it to the release branch.
3. Push to GitHub and create a pull request to merge the release branch into
`main`.
4. Make sure to test your new version!
5. Write a changelog.
The PR can help you identify differences between the last release (`main`)
and the next one (your release branch).
6. Merge the PR into main.
7. [Create a new GitHub release](https://github.com/ProvideQ/toolbox-web/releases/new) with a new tag named like your
version number `x.y.z` and use the changelog as the description.
9. Pull the main branch (`git checkout main && git pull`), merge it into the
develop branch (`git checkout develop && git pull && git merge main`) and
push it (`git push`).

## License
Copyright (c) 2022 ProvideQ
Copyright (c) 2022 - 2023 ProvideQ

This project is available under the [MIT License](./LICENSE)