From 2ac7082fd3633a63358a722efa40102816d5e4c0 Mon Sep 17 00:00:00 2001 From: John Hennig Date: Wed, 23 Feb 2022 14:52:04 +0100 Subject: [PATCH] Renamed dev tool `build.py` to `wheel.py`. --- tools/docs.py | 2 +- tools/release.md | 21 +++++++++++++-------- tools/{build.py => wheel.py} | 2 +- 3 files changed, 15 insertions(+), 10 deletions(-) rename tools/{build.py => wheel.py} (86%) diff --git a/tools/docs.py b/tools/docs.py index 9df564c..975be29 100644 --- a/tools/docs.py +++ b/tools/docs.py @@ -1,4 +1,4 @@ -"""Renders the documentation.""" +"""Builds the documentation locally.""" from subprocess import run from pathlib import Path diff --git a/tools/release.md b/tools/release.md index bb2b560..fed4df6 100644 --- a/tools/release.md +++ b/tools/release.md @@ -2,16 +2,21 @@ * Bump version number in `mph/meta.py`. * Add release notes to `docs/releases.md`. * Add dedicated commit for the version bump. -* Run tests for all supported Python versions. -* Push to GitHub: `git push origin main`. -* Check documentation build on Read-the-Docs. -* Tag commit with version number, e.g. `git tag v1.1.1`. -* Push the new tag: `git push --tags`. -* Activate, but hide, build for the tag on Read-the-Docs. -* Force `stable` branch to new release tag: `git branch -f stable`. +* Tag commit with version number, e.g. `git tag v1.1.4`. +* Force `stable` branch to latest commit: `git branch -f stable`. * Same for the current documentation branch: `git branch -f 1.1`. -* Push both branches upstream, e.g. `git push origin stable`. +* Run code linter: `pflake8`. +* Test docs build: `python tools/docs.py`. +* Test wheel build: `python tools/wheel.py`. +* Run tests for each supported Python/OS: `python3x tools/test.py`. * Run code coverage: `python tools/coverage.py`. +* Push to GitHub: +```console + git push origin main + git push --tags + git push origin stable + git push origin 1.1 +``` * Upload coverage report: `python tools/codecov.py`. * Create new release on GitHub and add release notes. * Publish to PyPI: `python tools/publish.py`. diff --git a/tools/build.py b/tools/wheel.py similarity index 86% rename from tools/build.py rename to tools/wheel.py index a80353d..b8afca9 100644 --- a/tools/build.py +++ b/tools/wheel.py @@ -1,4 +1,4 @@ -"""Builds the installation package.""" +"""Builds the packaged wheel locally.""" from subprocess import run from pathlib import Path