Skip to content

Commit f7d40a0

Browse files
committed
build: tweak the release instructions
1 parent 0f19b82 commit f7d40a0

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -222,11 +222,11 @@ check_kits: ## Check that dist/* are well-formed.
222222
python -m twine check dist/*
223223
@echo $$(ls -1 dist | wc -l) distribution kits
224224

225-
tag: ## Make a git tag with the version number.
225+
tag: #: Make a git tag with the version number (see howto.txt).
226226
git tag -s -m "Version $$(python setup.py --version)" $$(python setup.py --version)
227227
git push --follow-tags
228228

229-
bump_version: ## Edit sources to bump the version after a release.
229+
bump_version: #: Edit sources to bump the version after a release (see howto.txt).
230230
git switch -c nedbat/bump-version
231231
python igor.py bump_version
232232
git commit -a -m "build: bump version"

howto.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939
- merge to master
4040
- git push
4141
- Start the kits:
42+
- opvars github
4243
- Trigger the kit GitHub Action
4344
$ make build_kits
4445
- Build and publish docs:
@@ -71,12 +72,11 @@
7172
- Update readthedocs
7273
- @ https://readthedocs.org/projects/coverage/versions/
7374
- find the latest tag in the inactive list, edit it, make it active.
74-
- readthedocs won't find the tag until a commit is made on master.
7575
- keep just the latest version of each x.y release, make the rest active but hidden.
7676
- pre-releases should be hidden
7777
- IF NOT PRE-RELEASE:
7878
- @ https://readthedocs.org/dashboard/coverage/advanced/
79-
- change the default and latest versions to the new version
79+
- change the "default version" to the new version
8080
- @ https://readthedocs.org/projects/coverage/builds/
8181
- manually build "latest"
8282
- wait for the new tag build to finish successfully.

0 commit comments

Comments
 (0)