From 942e61592750c9eeecaf8d18be7c5037f891ea2e Mon Sep 17 00:00:00 2001 From: Andrew Date: Tue, 31 Dec 2024 22:05:54 +0000 Subject: [PATCH] add docs for releasing pint --- docs/dev/contributing.rst | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/docs/dev/contributing.rst b/docs/dev/contributing.rst index e70a3757d..040d77a65 100644 --- a/docs/dev/contributing.rst +++ b/docs/dev/contributing.rst @@ -115,7 +115,7 @@ features that work best as an extension package versus direct inclusion in Pint * Extension (separate packages) * Duck array types that wrap Pint (come above Pint - in :ref:`the type casting hierarchy <_numpy#technical-commentary>` + in :ref:`the type casting hierarchy <_numpy#technical-commentary>`) * Uses features independent/on top of the libraries @@ -130,6 +130,32 @@ features that work best as an extension package versus direct inclusion in Pint * Examples: Dask +Creating a release +------------------ + +Maintainers may create a new release by tagging a commit:: + + $ # do changes and commit + $ git tag -a 0.24.rc0 -m "Tagging 0.24.rc0" + $ git push --tags + +For the final release, add date to the 0.24 section in CHANGES, then:: + + $ git commit -a -m "Preparing for release 0.24" + $ git tag -a 0.24 -m "Tagging 0.24" + +Then add to CHANGES the following:: + + 0.25 (unreleased) + ----------------- + +And push the tags and CHANGES :: + + $ git commit -a -m "Back to development: 0.25" + $ git push --tags + + + .. _github: http://github.com/hgrecco/pint .. _`issue tracker`: https://github.com/hgrecco/pint/issues .. _`github docs`: https://help.github.com/articles/closing-issues-via-commit-messages/