Skip to content

Commit d271199

Browse files
committed
Add development docs, mostly to document the release process [skip ci]
1 parent 924b602 commit d271199

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

DEVELOPMENT.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Development
2+
3+
Dependencies are managed with [poetry](https://python-poetry.org/): `poetry install`
4+
5+
Tests are run with `./runtests`
6+
7+
## Releasing
8+
9+
CI handles releasing to PyPI.
10+
Releases on GitHub are created manually.
11+
12+
Here's how to do a release:
13+
14+
- Get all the desired changes into `master`
15+
- Wait for CI to pass that
16+
- Add a bump commit (see previous "Declare vX.Y.Z" commits; `poetry version` may be useful here)
17+
- Push that commit on master
18+
- Create a tag of that version number (`git tag v$(poetry version --short)`)
19+
- Push the tag (`git push --tags`)
20+
- CI will build & deploy that release
21+
- Create a Release on GitHub, ideally with a summary of changes

0 commit comments

Comments
 (0)