summaryrefslogtreecommitdiffstats
path: root/docs/source/devguide/packaging/release.md
diff options
context:
space:
mode:
authorCalum Lind <calumlind@gmail.com>2018-10-05 09:33:26 +0100
committerCalum Lind <calumlind@gmail.com>2018-11-01 17:38:10 +0000
commit82ecf8a4168cafdc2bf0f5c37f7fa45d55e8d265 (patch)
treeefd52f493583a3c99853d6577660da0695e95fc8 /docs/source/devguide/packaging/release.md
parent9dcd90056d4225f65046fab4ed37a25e9caeda06 (diff)
downloaddeluge-82ecf8a4168cafdc2bf0f5c37f7fa45d55e8d265.tar.gz
deluge-82ecf8a4168cafdc2bf0f5c37f7fa45d55e8d265.tar.bz2
deluge-82ecf8a4168cafdc2bf0f5c37f7fa45d55e8d265.zip
[Docs] Reorganise and add sections from wiki
- Change the layout and contents of docs to be better organised and follow ideas from: https://www.divio.com/blog/documentation/ - Use markdown for non-technical documents to speed up writing. - Added new sections and imported documents from Trac wiki. Build fixes: - Added a patch to fix recommonmark 0.4 and doc referencing: https://github.com/rtfd/recommonmark/issues/93 - Set docs build in tox to Py2.7 since there are problems with autodoc mocking multiple inheritance on Python 3 resulting in metaclass errors. - Supressed warning about `modules.rst` not in the toctree by creating a static `modules.rst` with `:orphan:` file directive and add to git. Also skip creating this toc file with sphinx-apidoc in setup and tox. - Simplified finding exported RPC and JSON API methods by adding an autodoc custom class directive. Removed unneeded __rpcapi.py.
Diffstat (limited to 'docs/source/devguide/packaging/release.md')
-rw-r--r--docs/source/devguide/packaging/release.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/source/devguide/packaging/release.md b/docs/source/devguide/packaging/release.md
new file mode 100644
index 000000000..4ecb93872
--- /dev/null
+++ b/docs/source/devguide/packaging/release.md
@@ -0,0 +1,37 @@
+# Release Checklist
+
+## Pre-Release
+
+- Update [translation](../contributing/translations.md) `po` files from
+ [Launchpad](https://translations.launchpad.net/deluge) account.
+- Changelog is updated with relevant commits and release date is added.
+- Version number increment:
+ - setup.py
+ - man pages
+ - osx/Info.plist
+ - Version and month `sed` commands:
+ - `git grep -l '2\.0\.0' | grep -v CHANGELOG.md | xargs sed -i 's/2\.0\.0/2\.0\.1/g'`
+ - `git grep -l 'October' docs/man | xargs sed -i 's/October/November/g'`
+- Increment copyright year:
+ - osx/Info.plist
+- Tag release in git and push upstream.
+ - e.g. `git tag -a deluge-2.0.0 -m "Deluge 2.0.0 Release"`
+
+## Release
+
+- Run `make_release` script on extracted tarball e.g.
+ - `make_release deluge-2.0.0`
+- Package for OSs, Ubuntu, Windows, OSX.
+- Upload source tarballs and packages to ftp.
+ (_Ensure file permissions are global readable:_ `0644`)
+
+## Post-Release
+
+- Update with version, hashes and release notes:
+ - ReleaseNotes (Create new version page and add link to this page)
+ - Forum announcement
+ - IRC welcome message
+ - Website `index.php` and `version` files
+ - [Wikipedia](http://en.wikipedia.org/wiki/Deluge_%28software%29)
+- Trac close the milestone and add new version for tickets.
+- Ensure all stable branch commits are also applied to development branch.