Skip to content

New release quick guide (for maintainers)

Alejandro González edited this page Sep 30, 2021 · 10 revisions

This guide is intended for repository maintainers and not for end users. If you do not plan on contributing to this repository, feel free to ignore it.

Steps for a new release

These steps are based on the corresponding GitHub documentation.

  1. Push commits to an unprotected branch.
  2. When the release is ready, update the existing major version tag, if applicable (in this case, v1), by running the following commands on your machine:
$ git tag -f v1 <commit hash>
$ git push --force origin v1
  1. Get your commits merged on a protected branch (for example, release/v1) via a PR.
  2. Create a GitHub release with the changelog and the full version, including patch and minor numbers, on the protected branch. The relevant fields should look like this:

Release page fields preview