Skip to content

Commit

Permalink
build: more convenient cheats
Browse files Browse the repository at this point in the history
  • Loading branch information
nedbat committed Mar 16, 2023
1 parent 02b7599 commit 402858f
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ coverage.json
# Stuff in the root.
build
*.egg-info
cheats.txt
dist
htmlcov
MANIFEST
Expand Down
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ clean: clean_platform ## Remove artifacts of test execution, installation, etc

sterile: clean ## Remove all non-controlled content, even if expensive.
rm -rf .tox
rm -f cheats.txt

help: ## Show this help.
@# Adapted from https://www.thapaliya.com/en/writings/well-documented-makefiles/
Expand Down Expand Up @@ -158,6 +159,9 @@ REPO_OWNER = nedbat/coveragepy
edit_for_release: ## Edit sources to insert release facts.
python igor.py edit_for_release

cheats: ## Create some useful snippets for releasing.
python igor.py cheats | tee cheats.txt

relbranch: ## Create the branch for releasing.
echo git switch -c nedbat/release-$$(date +%Y%m%d)

Expand Down
7 changes: 4 additions & 3 deletions howto.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,17 @@
- Check that the current virtualenv matches the current coverage branch.
- start branch for release work
$ make relbranch
- Version number in coverage/version.py
- Edit version number in coverage/version.py
version_info = (4, 0, 2, "alpha", 1)
version_info = (4, 0, 2, "beta", 1)
version_info = (4, 0, 2, "candidate", 1)
version_info = (4, 0, 2, "final", 0)
- make sure: _dev = 0
- Supported Python version numbers. Search for "PYVERSIONS".
- Edit supported Python version numbers. Search for "PYVERSIONS".
- Update source files with release facts:
$ make edit_for_release
- run `python igor.py cheats` to get useful snippets for next steps.
- Get useful snippets for next steps, and beyond, in cheats.txt
$ make cheats
- Look over CHANGES.rst
- Update README.rst
- "New in x.y:"
Expand Down

0 comments on commit 402858f

Please sign in to comment.