GlcoinCore/jam
1
0
Fork 0
mirror of https://github.com/joinmarket-webui/jam.git synced 2026-08-13 12:33:26 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
jam/docs/releasing.md
Daniel f11b1fea66
docs: add contribution guide and refactor docs (#119) 
* Add contributing guide

* Restructure docs

* Update CONTRIBUTING.md

Co-authored-by: Max Hillebrand <30683012+MaxHillebrand@users.noreply.github.com>

* Update CONTRIBUTING.md

Co-authored-by: d11n <mail@dennisreimann.de>

* Add syntax to code fences

Co-authored-by: Max Hillebrand <30683012+MaxHillebrand@users.noreply.github.com>
Co-authored-by: d11n <mail@dennisreimann.de>
2022-02-23 11:12:10 +01:00

1.2 KiB
Raw Permalink Blame History

Release Process

This documents our release process.

Update the Code

Checkout master and make sure to pull all the latest changes that sould be included in the release.

Bump the Version

Use npm version to bump the version and update the changelog. Most of the time you will want to run:

npm version <patch|minor|major>

For more details and other possible release types see the npm docs.

This will:

  1. Create and checkout a branch for the release preparation: prepare-v<new-version>-<timestamp>
  2. Bump the version in package.json and package.lock.json
  3. Update the changelog
  4. Commit the changes and push the branch
  5. If you have the GitHub CLI installed it will automatically open a draft pull request to master

Merge the Release Pull Request

This is a good point to clean up the changelog if needed and get feedback on the release. When everyone is happy with the release, merge the pull request to master.

Tag the Release

Back on master, tag the release and based on the new tag crate a release on GitHub. This is a step we might automate completely via GitHub Actions in the future.