summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2021-01-23 19:42:03 +0200
committerLars Wirzenius <liw@liw.fi>2021-01-23 19:42:03 +0200
commit9b62da651481ed87c4c0b8cecc62cf4501a9531f (patch)
tree389e2536388b19732efd8516aacb2c93420e5f50
parentb5da156d8857f1e43006a59f0c972f3471c7fd44 (diff)
downloadobnam2-9b62da651481ed87c4c0b8cecc62cf4501a9531f.tar.gz
_doc: add preliminary release checklist
-rw-r--r--NEWS12
-rw-r--r--RELEASE.md34
2 files changed, 46 insertions, 0 deletions
diff --git a/NEWS b/NEWS
new file mode 100644
index 0000000..78b12be
--- /dev/null
+++ b/NEWS
@@ -0,0 +1,12 @@
+# NEWS for Obnam2, the backup software
+
+This file summarizes changes between releases of the second generation
+of Obnam, the backup software. The software is technically called
+"obnam2" to distinguish it from the first generation of Obnam, which
+ended in 2017 with version number 1.22.
+
+
+## Obnam2 version 0.2, not yet released
+
+This if the first release of Obnam2. It can just barely make and
+restore backups. It's ready for a light trial, but not for real use.
diff --git a/RELEASE.md b/RELEASE.md
new file mode 100644
index 0000000..c9f886d
--- /dev/null
+++ b/RELEASE.md
@@ -0,0 +1,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/