Browse code
create a release issue template
Anton Akhmerov authored on 23/04/2019 14:01:13
Showing 2 changed files
| 1 | 1 |
new file mode 100644 |
| ... | ... |
@@ -0,0 +1,53 @@ |
| 1 |
+# Release %vX.Y.Z **UPDATE THIS** |
|
| 2 |
+ |
|
| 3 |
+This is a checklist based on the [release document](RELEASE.rst); consult it for more details. |
|
| 4 |
+ |
|
| 5 |
+## Preflight checks |
|
| 6 |
+ |
|
| 7 |
+- [ ] All the issues from this milestone are resolved |
|
| 8 |
+- [ ] Ensure that tests pass (either on [stable](https://gitlab.kwant-project.org/kwant/kwant/tree/stable) or on [master](https://gitlab.kwant-project.org/kwant/kwant/tree/master) branch) |
|
| 9 |
+- [ ] Documentation looks correct https://test.kwant-project.org/doc/<branch name> |
|
| 10 |
+- [ ] [Whatnew](doc/source/pre/whatsnew) is up to date |
|
| 11 |
+- [ ] `AUTHORS.rst` and `.mailmap` are up to date (run `git shortlog -s | sed -e "s/^ *[0-9\t ]*//"| xargs -i sh -c 'grep -q "{}" AUTHORS.rst || echo "{}"'`)
|
|
| 12 |
+ |
|
| 13 |
+## Make a release, but do not publish it yet |
|
| 14 |
+ |
|
| 15 |
+- [ ] Tag the release |
|
| 16 |
+- [ ] Build the source tarball and inspect it |
|
| 17 |
+- [ ] Build the documentation |
|
| 18 |
+ |
|
| 19 |
+## Test packaging |
|
| 20 |
+ |
|
| 21 |
+These steps may be done in parallel |
|
| 22 |
+ |
|
| 23 |
+### Debian |
|
| 24 |
+ |
|
| 25 |
+- [ ] Follow the steps for building the Debian packages from [RELEASE.rst](RELEASE.rst) |
|
| 26 |
+ |
|
| 27 |
+### Conda |
|
| 28 |
+ |
|
| 29 |
+- [ ] Publish the release candidate source tarball "somewhere on the internet" (SOTI) |
|
| 30 |
+- [ ] open a PR to the [conda-forge/kwant-feedstock](https://github.com/conda-forge/kwant-feedstock/) repo on Github. Make sure to mark the PR as WIP so that it doesn't get merged in accidentally |
|
| 31 |
+ - [ ] set the upstream tarball URL (in meta.yaml) to SOTI |
|
| 32 |
+ - [ ] update the tarball hash in meta.yaml |
|
| 33 |
+- [ ] See if the package builds |
|
| 34 |
+ |
|
| 35 |
+## Publish the release |
|
| 36 |
+- [ ] push the tag |
|
| 37 |
+- [ ] upload the source tarball to PyPI |
|
| 38 |
+- [ ] upload the source tarball to the Kwant website |
|
| 39 |
+- [ ] publish the debian packages |
|
| 40 |
+- [ ] publish the ubuntu packages |
|
| 41 |
+- [ ] create a new version of the Kwant conda-forge feedstock, and open a pull request to upstream |
|
| 42 |
+- [ ] upload the documentation to the Kwant website |
|
| 43 |
+- [ ] update the Kwant website to say that Conda is the preferred way to install Kwant on Windows |
|
| 44 |
+ |
|
| 45 |
+## Announce the release |
|
| 46 |
+- [ ] Write a short post summarizing the highlights on the Kwant website |
|
| 47 |
+- [ ] post to the Kwant mailing list |
|
| 48 |
+ |
|
| 49 |
+## Working towards next release |
|
| 50 |
+- [ ] add a whatsnew file for the next release |
|
| 51 |
+- [ ] tag this release with an `a0` suffix |
|
| 52 |
+- [ ] push this tag to the official Kwant repository |
|
| 53 |
+- [ ] create a milestone for the next release |
| ... | ... |
@@ -3,6 +3,10 @@ Making a Kwant release |
| 3 | 3 |
|
| 4 | 4 |
This document guides a contributor through creating a release of Kwant. |
| 5 | 5 |
|
| 6 |
+Create a release issue |
|
| 7 |
+###################### |
|
| 8 |
+ |
|
| 9 |
+Use the correct `issue template <gitlab.kwant-project.org/kwant/kwant/issues/new?issuable_template=release>`_, adjust it if necessary. |
|
| 6 | 10 |
|
| 7 | 11 |
Preflight checks |
| 8 | 12 |
################ |