codex-storage
/
deluge
mirror of https://github.com/codex-storage/deluge.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
deluge/docs/source/devguide/packaging/release.md

50 lines
1.6 KiB
Markdown
Raw Normal View History

[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.
2018-10-05 08:33:26 +00:00
# Release Checklist
[Docs] Add spellchecking with pyenchant - Use sphinxcontrib.spelling with custom wordlist. - Skip the checking of the modules documents as they raise false-positives. - Add a setup.py spellcheck_docs command. - Fix spelling and other issues. - Add a doc favicon.
2019-06-15 18:44:33 +00:00
## Pre-release
[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.
2018-10-05 08:33:26 +00:00
[Docs] Update release checklist
2019-06-07 13:47:49 +00:00
- Update [translation] `po` files from [Launchpad] account.
[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.
2018-10-05 08:33:26 +00:00
- Changelog is updated with relevant commits and release date is added.
[Docs] Updates to release checklist
2019-06-11 10:33:23 +00:00
- Docs [release notes] are updated.
[Docs] Update release checklist
2019-06-07 13:47:49 +00:00
- Tag release in git and push upstream e.g.
git tag -a deluge-2.0.0 -m "Deluge 2.0.0 Release"
[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.
2018-10-05 08:33:26 +00:00
## Release
[Docs] Cleanup changelog and docs
2019-06-05 22:32:37 +00:00
- Create source and wheel distributions:
[Docs] Update release checklist
2019-06-07 13:47:49 +00:00
python setup.py sdist bdist_wheel
- Upload to PyPi (currently only accepts `tar.gz`):
[Docs] Cleanup changelog and docs
2019-06-05 22:32:37 +00:00
[Docs] Update release checklist
2019-06-07 13:47:49 +00:00
twine upload dist/deluge-2.0.0.tar.gz dist/deluge-2.0.0-py3-none-any.whl
[Docs] Cleanup changelog and docs
2019-06-05 22:32:37 +00:00
[Docs] Update release checklist
2019-06-07 13:47:49 +00:00
- Calculate `sha256sum` for each file e.g.
[Docs] Cleanup changelog and docs
2019-06-05 22:32:37 +00:00
[Docs] Update release checklist
2019-06-07 13:47:49 +00:00
cd dist; sha256sum deluge-2.0.0.tar.xz > deluge-2.0.0.tar.xz.sha256
- Upload source tarballs and packages to `download.deluge-torrent.org`.
- Ensure file permissions are global readable: `0644`
- Sub-directories correspond to _major.minor_ version e.g. all `2.0.x` patch
releases are stored in `source/2.0`.
[Docs] Updates to release checklist
2019-06-11 10:33:23 +00:00
- Change release version in `version` files.
- Run `trigger-deluge` to sync OSUOSL ftp site.
- Create packages (Ubuntu, Windows, OSX).
[Docs] Add spellchecking with pyenchant - Use sphinxcontrib.spelling with custom wordlist. - Skip the checking of the modules documents as they raise false-positives. - Add a setup.py spellcheck_docs command. - Fix spelling and other issues. - Add a doc favicon.
2019-06-15 18:44:33 +00:00
- Ubuntu: <https://code.launchpad.net/~deluge-team/+recipe/stable-releases>
[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.
2018-10-05 08:33:26 +00:00
[Docs] Add spellchecking with pyenchant - Use sphinxcontrib.spelling with custom wordlist. - Skip the checking of the modules documents as they raise false-positives. - Add a setup.py spellcheck_docs command. - Fix spelling and other issues. - Add a doc favicon.
2019-06-15 18:44:33 +00:00
## Post-release
[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.
2018-10-05 08:33:26 +00:00
- Update with version, hashes and release notes:
[Docs] Update release checklist
2019-06-07 13:47:49 +00:00
- Publish docs on [ReadTheDocs].
[Docs] Updates to release checklist
2019-06-11 10:33:23 +00:00
- Forum announcement.
- IRC welcome message.
[Docs] Update release checklist
2019-06-07 13:47:49 +00:00
- [Wikipedia]
- Close Trac milestone and add new milestone version for future tickets.
[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.
2018-10-05 08:33:26 +00:00
- Ensure all stable branch commits are also applied to development branch.
[Docs] Update release checklist
2019-06-07 13:47:49 +00:00
[readthedocs]: https://deluge.readthedocs.io
[wikipedia]: http://en.wikipedia.org/wiki/Deluge_%28software%29
[launchpad]: https://translations.launchpad.net/deluge
[Docs] Updates to release checklist
2019-06-11 10:33:23 +00:00
[translation]: ../../contributing/translations.md
[release notes]: ../../release/index.md