summaryrefslogtreecommitdiff
path: root/RELEASE.md
blob: c9f886d1b5c4a2448b17139ff4a8bbf99976c5f6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# Release checklist for Obnam2

Follow these steps to make a release of Obnam2.

* create a `release` branch
* update `NEWS` with changes for the new release
* update the version number everywhere it needs to be updated; use
  [semantic versioning][]
  - `NEWS`
  - `debian/changelog`
  - `Cargo.toml`
* commit everything
* push changes to gitlab, create merge request, merge, pull back to
  local `main` branch
* create a signed, annotated git tag `vX.Y.Z` for version X.Y.Z for
  the release commit
* push tag to `gitlab.com` and `git.liw.fi`
* announce new release
  - obnam.org blog, possibly other blogs
  - `#obnam` IRC channel
  - Obnam room on Matrix
  - social media

* prepare `main` branch for further development
  - create new branch
  - update version number again by adding `+git` to it
    - add a new entry to `NEWS` with the `+git` version
	- ditto `debian/changelog`
  - commit
  - push to gitlab, create MR, merge, pull back down to local `main`

* continue development

[semantic versioning]: https://semver.org/