Skip to content

Commit

Permalink
Renamed dev tool build.py to wheel.py.
Browse files Browse the repository at this point in the history
  • Loading branch information
john-hen committed Feb 23, 2022
1 parent 49a2e00 commit 2ac7082
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 10 deletions.
2 changes: 1 addition & 1 deletion tools/docs.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Renders the documentation."""
"""Builds the documentation locally."""

from subprocess import run
from pathlib import Path
Expand Down
21 changes: 13 additions & 8 deletions tools/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
2 changes: 1 addition & 1 deletion tools/build.py → tools/wheel.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Builds the installation package."""
"""Builds the packaged wheel locally."""

from subprocess import run
from pathlib import Path
Expand Down

0 comments on commit 2ac7082

Please sign in to comment.