Skip to content

Commit 87f0426

Browse files
committed
update contributing docs with release checklist
1 parent 233fe8a commit 87f0426

File tree

3 files changed

+25
-16
lines changed

3 files changed

+25
-16
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -70,17 +70,26 @@ doit release
7070
This will recreate the `test` environment with the specified lockfile, and
7171
repeat all the steps.
7272

73-
### Releasing
74-
75-
- ensure `VERSION` has been increased appropriately
76-
- ensure `HISTORY.ipynb` is up-to-date
77-
- (usually) grab the `dist` assets from CI, unpack into `./dist`
78-
- make a GitHub release, adding the `.tar.gz`, `.whl`, and `SHA256SUMS`
79-
- upload to PyPI
80-
73+
## Releasing
74+
75+
- [ ] merge all outstanding PRs
76+
- [ ] start a release issue with a checklist (maybe like this one)
77+
- [ ] ensure `VERSION` has been increased appropriately
78+
- [ ] ensure the `HISTORY.ipynb` is up-to-date
79+
- [ ] validate on binder
80+
- [ ] validate on ReadTheDocs
81+
- [ ] wait for a successful build of `master`
82+
- [ ] download the `dist` archive and unpack somewhere (maybe a fresh `dist`)
83+
- [ ] create a new release through the GitHub UI
84+
- [ ] paste in the relevant `HISTORY` entries
85+
- [ ] upload the artifacts
86+
- [ ] actually upload to pypi.org
8187
```bash
8288
doit publish
8389
```
84-
85-
- do a post-mortem issue
86-
- bump `VERSION` to a working status
90+
- [ ] postmortem
91+
- [ ] handle `conda-forge` feedstock tasks
92+
- [ ] validate on binder via simplest-possible gists
93+
- [ ] activate the version on ReadTheDocs
94+
- [ ] bump `VERSION` to next development version
95+
- [ ] update release procedures

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"singleQuote": true
88
},
99
"devDependencies": {
10-
"prettier": "^2.1.2"
10+
"prettier": "^2.5.1"
1111
},
1212
"scripts": {
1313
"prettier": "prettier --write --list-different \"./*.{json,md,yml}\" \"{.github,.binder,docs}/**/*.{json,md,yml,css}\""

yarn.lock

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# yarn lockfile v1
33

44

5-
prettier@^2.1.2:
6-
version "2.2.0"
7-
resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.2.0.tgz#8a03c7777883b29b37fb2c4348c66a78e980418b"
8-
integrity sha512-yYerpkvseM4iKD/BXLYUkQV5aKt4tQPqaGW6EsZjzyu0r7sVZZNPJW4Y8MyKmicp6t42XUPcBVA+H6sB3gqndw==
5+
prettier@^2.5.1:
6+
version "2.5.1"
7+
resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.5.1.tgz#fff75fa9d519c54cf0fce328c1017d94546bc56a"
8+
integrity sha512-vBZcPRUR5MZJwoyi3ZoyQlc1rXeEck8KgeC9AwwOn+exuxLxq5toTRDTSaVrXHxelDMHy9zlicw8u66yxoSUFg==

0 commit comments

Comments
 (0)