diff options
| author | Alex Grönholm <alex.gronholm@nextday.fi> | 2020-01-22 08:01:58 +0200 |
|---|---|---|
| committer | Alex Grönholm <alex.gronholm@nextday.fi> | 2020-01-22 08:40:15 +0200 |
| commit | 9aa8480b5d2d033dbd9b634fa736d8f25150c40d (patch) | |
| tree | e434bcd616c613baf693999c1331e3650944684b /docs | |
| parent | e29a5bdd0817f4068aac83edf110caf7c421f574 (diff) | |
| download | wheel-git-9aa8480b5d2d033dbd9b634fa736d8f25150c40d.tar.gz | |
Switched to setuptools_scm
New versions are now made by declaring a new version in the changelog (docs/news.rst) and pushing this change to Github. The workflow will see this version and create a new tag which then triggers the release workflow.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/development.rst | 13 | ||||
| -rw-r--r-- | docs/news.rst | 3 |
2 files changed, 8 insertions, 8 deletions
diff --git a/docs/development.rst b/docs/development.rst index 53c33e3..3726040 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -83,11 +83,8 @@ The wheel project welcomes help in the following ways: Release Process --------------- -#. Make sure there is a version block for this release in ``docs/news.rst`` - that mentions all the new user-facing changes -#. Add the version tag to the repository using ``git tag X.Y.Z`` - (e.g. ``git tag 1.0.1``) -#. Push the new tag to Github using ``git push --tags`` - -When a new tag is pushed to Github, Travis will pick it up and automatically -build the sdist and wheel and upload them to PyPI. +To make a new release, edit ``docs/news.rst`` and add a new version and replace +``**UNRELEASED**`` with a release version and date, like +``**X.Y.Z (20XX-YY-ZZ)**``. The github workflow will pick up the new version +and create a new tag, which will then trigger the release workflow which will +package the project and publish the resulting artifacts to PyPI. diff --git a/docs/news.rst b/docs/news.rst index e9423b1..731c4d4 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -10,6 +10,9 @@ Release Notes - Moved the contents of setup.py to setup.cfg - Fixed duplicate RECORD file when using "wheel pack" on Windows - Switched the project to use the "src" layout +. Switched to setuptools_scm_ for versioning + + .. _setuptools_scm: https://github.com/pypa/setuptools_scm/ **0.33.6 (2019-08-18)** |
