Skip to content

Commit 1138018

Browse files
committed
docs: add entry about how to release in the developer guide
1 parent ec35aa5 commit 1138018

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

CHANGELOG.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
88

99
## [1.0.1] - 2022-05-04
1010

11+
### Added
12+
13+
- Steps for release in the developer guide
14+
1115
### Fixed
1216

13-
- Specify `Compounder` type using a protocol to avoid mypy_extensions import
17+
- Specify `Compounder` type using a protocol to avoid `mypy_extensions` import
1418

1519
## [1.0.0] - 2022-05-04
1620

docs/source/developer_guide.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,17 @@ Build this documentation
6363
.. _poetry: https://python-poetry.org/
6464

6565

66+
Releases
67+
========
68+
69+
1. Create a new section in CHANGELOG.md
70+
2. Add a new release in GitHub (see `release documentation`_), creating a new tag
71+
3. CI in ``on_release.yml`` will apply the tag as the build version and publish to PyPi
72+
73+
.. _release documentation: https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository
74+
75+
76+
6677
Architecture
6778
============
6879

0 commit comments

Comments
 (0)