github/datasette
1
0
Fork 0
mirror of https://github.com/simonw/datasette.git synced 2025-12-10 16:51:24 +01:00
Code Issues Projects Releases Packages Wiki Activity

Improved release process documentation

Browse source
This commit is contained in:
Simon Willison 2018-12-16 13:47:26 -08:00
commit 1e2db8547b
No known key found for this signature in database
GPG key ID: 17E2DEA2588B7F52
1 changed files with 11 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/contributing.rst
View file

@ -106,6 +106,8 @@ Datasette releases are performed using tags. When a new version tag is pushed to
* Build a wheel bundle of the underlying Python source code * Build a wheel bundle of the underlying Python source code
* Push that new wheel up to PyPI: https://pypi.org/project/datasette/ * Push that new wheel up to PyPI: https://pypi.org/project/datasette/
To deploy new releases you will need to have push access to the main Datasette GitHub repository.
Datasette follows `Semantic Versioning <https://semver.org/>`__:: Datasette follows `Semantic Versioning <https://semver.org/>`__::
major.minor.patch major.minor.patch
@ -116,13 +118,17 @@ We increment ``minor`` for new features.
We increment ``patch`` for bugfix releass. We increment ``patch`` for bugfix releass.
To release a new version, first create a commit that updates :ref:`the changelog <changelog>` with highlights of the new version. An example `commit can be seen here <https://github.com/simonw/datasette/commit/3dc0b3fa8c9b9bd81540ffe20c8b7e7a72465274>`__. To release a new version, first create a commit that updates :ref:`the changelog <changelog>` with highlights of the new version. An example `commit can be seen here <https://github.com/simonw/datasette/commit/3dc0b3fa8c9b9bd81540ffe20c8b7e7a72465274>`__::
Then run the following:: # Update changelog
git commit -m "Release 0.25.2" -a
git push
For non-bugfix releases you may want to update the news section of ``README.md`` as part of the same commit.
Wait long enough for Travis to build and deploy the demo version of that commit (otherwise the tag deployment may fail to alias to it properly). Then run the following::
git tag 0.25.2 git tag 0.25.2
git push && git push --tags git push --tags
You will need to have push access to the main Datasette GitHub repository.
Once the release is out, you can manually update https://github.com/simonw/datasette/releases Once the release is out, you can manually update https://github.com/simonw/datasette/releases