mirror of
https://github.com/jlu5/PyLink.git
synced 2024-11-01 09:19:23 +01:00
Document the PyLink release process
This commit is contained in:
parent
c690916da9
commit
c94a92bd5f
@ -19,6 +19,7 @@ PyLink is an a modular, plugin-based IRC services framework. It uses swappable p
|
|||||||
- [Supported named channel modes](channel-modes.csv)
|
- [Supported named channel modes](channel-modes.csv)
|
||||||
- [Supported named user modes](user-modes.csv)
|
- [Supported named user modes](user-modes.csv)
|
||||||
- [Services bot API/Creating your own service bots](services-api.md)
|
- [Services bot API/Creating your own service bots](services-api.md)
|
||||||
|
- [Release Process for PyLink](release-process.md)
|
||||||
|
|
||||||
### Future topics (not yet available)
|
### Future topics (not yet available)
|
||||||
- [Writing tests for PyLink modules](writing-tests.md)
|
- [Writing tests for PyLink modules](writing-tests.md)
|
||||||
|
17
docs/technical/release-process.md
Normal file
17
docs/technical/release-process.md
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
# Release Process for PyLink
|
||||||
|
|
||||||
|
This document documents the steps that I (James) use to release updates to PyLink.
|
||||||
|
|
||||||
|
1) Draft the next release & changelog at https://github.com/GLolol/PyLink/releases
|
||||||
|
|
||||||
|
2) Copy/export the changelog draft to [RELNOTES.md](../../RELNOTES.md), using a new section.
|
||||||
|
|
||||||
|
- [`export_github_relnotes.py`](https://github.com/GLolol/codescraps/blob/master/utils/export_github_relnotes.py) allows automating this process, using the GitHub API and an optional login to read unpublished drafts.
|
||||||
|
|
||||||
|
3) Bump the version in the [`VERSION`](VERSION) file.
|
||||||
|
|
||||||
|
4) Commit the changes to `VERSION` and `RELNOTES.md`, and tag+sign this commit as the new release. Do not prefix version numbers with "v".
|
||||||
|
|
||||||
|
5) Publish the release via the GitHub release page.
|
||||||
|
|
||||||
|
6) For stable releases, also upload to PyPI: `python3 setup.py sdist upload`
|
Loading…
Reference in New Issue
Block a user