... | ... |
@@ -19,8 +19,8 @@ bumped. |
19 | 19 |
#### Ensure that all tests pass |
20 | 20 |
|
21 | 21 |
For major and minor releases we will be tagging the ``master`` branch. |
22 |
-This should be as simple as verifying that the |
|
23 |
-[latest CI pipeline](https://gitlab.kwant-project.org/qt/adaptive/pipelines) |
|
22 |
+This should be as simple as verifying that the |
|
23 |
+[latest CI pipeline](https://gitlab.kwant-project.org/qt/adaptive/pipelines) |
|
24 | 24 |
succeeded. |
25 | 25 |
|
26 | 26 |
|
... | ... |
@@ -50,7 +50,7 @@ rm -fr build dist |
50 | 50 |
python setup.py sdist bdist_wheel |
51 | 51 |
``` |
52 | 52 |
|
53 |
-This creates the file `dist/adaptive-<version>.tar.gz`. It is a good idea to unpack it |
|
53 |
+This creates the file `dist/adaptive-<version>.tar.gz`. It is a good idea to unpack it |
|
54 | 54 |
and check that the tests run: |
55 | 55 |
``` |
56 | 56 |
tar xzf dist/adaptive*.tar.gz |
... | ... |
@@ -58,13 +58,33 @@ cd adaptive-* |
58 | 58 |
py.test . |
59 | 59 |
``` |
60 | 60 |
|
61 |
-## Upload to PyPI |
|
61 |
+### Create an empty commit for new development and tag it |
|
62 |
+``` |
|
63 |
+git commit --allow-empty -m 'start development towards v<version+1>' |
|
64 |
+git tag -am 'Start development towards v<version+1>' v<version+1>-dev |
|
65 |
+``` |
|
66 |
+ |
|
67 |
+Where `<version+1>` is `<version>` with the minor version incremented |
|
68 |
+(or major version incremented and minor and patch versions then reset to 0). |
|
69 |
+This is necessary so that the reported version for any further commits is |
|
70 |
+`<version+1>-devX` and not `<version>-devX`. |
|
71 |
+ |
|
72 |
+ |
|
73 |
+## Publish the release |
|
74 |
+ |
|
75 |
+### Push the tags |
|
76 |
+``` |
|
77 |
+git push origin v<version> v<version+1>-dev |
|
78 |
+``` |
|
79 |
+ |
|
80 |
+### Upload to PyPI |
|
62 | 81 |
|
63 | 82 |
``` |
64 | 83 |
twine upload dist/* |
65 | 84 |
``` |
66 | 85 |
|
67 | 86 |
|
87 |
+ |
|
68 | 88 |
## Update the [conda-forge recipe](https://github.com/conda-forge/adaptive-feedstock) |
69 | 89 |
|
70 | 90 |
* Fork the [feedstock repo](https://github.com/conda-forge/adaptive-feedstock) |