summaryrefslogtreecommitdiff
path: root/BUILD.md
diff options
context:
space:
mode:
authorMicah Lee <micah@micahflee.com>2020-08-24 20:10:31 -0700
committerMicah Lee <micah@micahflee.com>2020-08-24 20:10:31 -0700
commit23899fad581f89e67ecad72dff964dd2af17b55d (patch)
treea8c10a26538eec8122a13b4428c9d7a1eb1c7f50 /BUILD.md
parent584ca92498c57570f63cffd551763c031faa2015 (diff)
downloadonionshare-23899fad581f89e67ecad72dff964dd2af17b55d.tar.gz
onionshare-23899fad581f89e67ecad72dff964dd2af17b55d.zip
Version bump to 2.3 and update changelog (for now)
Diffstat (limited to 'BUILD.md')
-rw-r--r--BUILD.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/BUILD.md b/BUILD.md
index efc8cd27..cb59bdd8 100644
--- a/BUILD.md
+++ b/BUILD.md
@@ -299,15 +299,21 @@ To edit and build the documentation, see the [docs readme](/docs/README.md).
This section documents the release process. Unless you're a core OnionShare developer making a release, you'll probably never need to follow it.
-## Changelog, version, and signed git tag
+## Changelog, version, docs, and signed git tag
-Before making a release, all of these should be complete:
+Before making a release, you must update the version in these places:
* `share/version.txt` should have the correct version
* `pyproject.toml` should have the correct version
+* `docs/source/conf.py` should have the correct version
* `install/org.onionshare.OnionShare.appdata.xml` should have the correct version
* `install/onionshare.nsi` should have the correct version, for the Windows installer
+
+In addition to that, you must:
+
+* `install/org.onionshare.OnionShare.appdata.xml` should have the correct release date, and links to correct screenshots
* `CHANGELOG.md` should be updated to include a list of all major changes since the last release
+* Update all of the documentation to cover new features, including taking new screenshots if necessary
* There must be a PGP-signed git tag for the version, e.g. for OnionShare 2.1, the tag must be `v2.1`
The first step for the Linux, macOS, and Windows releases is the same: