File: RELEASE.md

package info (click to toggle)
libh3 4.4.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 48,696 kB
  • sloc: ansic: 20,847; javascript: 632; sh: 46; makefile: 9
file content (15 lines) | stat: -rw-r--r-- 654 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# Release Process

1. Create a PR "Preparing for release X.Y.Z" against master branch
    * Alter CHANGELOG.md from `[Unreleased]` to `[X.Y.Z] YYYY-MM-DD`
    * In the `build` directory, run `make update-version` and give `X.Y.Z` when
      prompted (this updates the VERSION file, so don't change it manually)
    * Check that all merges that need to be in the changelog are present
    * Get reviews and merge the PR

2. Create a release "Release X.Y.Z" on Github
    * Create Tag `vX.Y.Z`
    * Copy CHANGELOG.md into the release notes

3. Publish the website to display the latest docs
    * This should now be done automatically via Github Actions.