Browse code

Add release instructions

Joseph Weston authored on 12/11/2019 14:51:40
Showing 1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,39 @@
1
+# Release Instructions
2
+
3
+This document guides a contributor through creating a release of qsim.
4
+
5
+## Preflight checks
6
+
7
+### Ensure all tests pass
8
+
9
+Locally you can run `tox` to check that all tests pass, and check that tests
10
+against all supported environments are passing also by checking qsim's
11
+[GitHub actions](https://github.com/jbweston/qsim/actions?query=branch%3Amaster+workflow%3Atests).
12
+
13
+#### Verify that `AUTHORS.md` is up-to-date
14
+
15
+The following command shows the number of commits per author since the last
16
+annotated tag:
17
+```
18
+t=$(git describe --abbrev=0); echo Commits since $t; git shortlog -s $t..
19
+```
20
+
21
+## Make the release
22
+
23
+Run
24
+
25
+```
26
+bumpversion release  # bump version from .devX to release version
27
+git push --tags      # push tagged release to upstream
28
+flit publish         # publish to PyPI
29
+```
30
+
31
+## Start work on the next release
32
+
33
+Run
34
+
35
+```
36
+bumpversion minor
37
+```
38
+
39
+To start work on the next release