From 27eebda3c7f25e4507e381f790c985ae11c687b1 Mon Sep 17 00:00:00 2001 From: adrinjalali Date: Thu, 25 Aug 2022 16:26:35 +0200 Subject: [PATCH 1/5] DOC release refinements --- CONTRIBUTING.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 6637ca69..1047e355 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -83,11 +83,12 @@ Releases are created using `manual GitHub workflows `_. As a maintainer, follow these steps: -1. Create a new branch -2. Bump the version defined in ``skops/__init__.py`` -3. Git grep for any TODO's that need fixing before the release (e.g. +1. Check and update the ``CHANGES.md`` +2. Create a new branch with the name "0.version.X", e.g. "0.2.X". This branch + will have all tags for all releases under 0.2. +3. Bump the version defined in ``skops/__init__.py`` +4. Git grep for any TODO's that need fixing before the release (e.g. deprecations) -4. Update the ``CHANGES.md`` 5. Create a PR with all the changes and have it reviewed and merged 6. Use the `GitHub action `__ to @@ -102,4 +103,5 @@ As a maintainer, follow these steps: 9. Update the patch version of the package to a new dev version, e.g. from ``v0.3.0`` to ``v0.3.dev1`` 10. Check that the new stable branch of documentation was built correctly on - `readthedocs `_ + `readthedocs `_, and make + sure all relevant releases are *active*. From 011517b1f46296ed0fbbd57cd577dda597f99495 Mon Sep 17 00:00:00 2001 From: adrinjalali Date: Thu, 25 Aug 2022 16:28:23 +0200 Subject: [PATCH 2/5] more --- CONTRIBUTING.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 1047e355..f7a311a1 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -84,12 +84,15 @@ Releases are created using `manual GitHub workflows As a maintainer, follow these steps: 1. Check and update the ``CHANGES.md`` -2. Create a new branch with the name "0.version.X", e.g. "0.2.X". This branch - will have all tags for all releases under 0.2. +2. For a major release, create a new branch with the name "0.version.X", e.g. + "0.2.X". This branch will have all tags for all releases under 0.2. 3. Bump the version defined in ``skops/__init__.py`` 4. Git grep for any TODO's that need fixing before the release (e.g. deprecations) 5. Create a PR with all the changes and have it reviewed and merged +6. Create a tag with the format "v0.version", e.g. "v0.2", and push it to the + remote repository. Use this tag for releasing the package. If there is a + minor release under the same branch, it would be "v0.2.1" for example. 6. Use the `GitHub action `__ to create a new release on **TestPyPI**. Check it for correctness `on test.pypi From f9bc104b537398476eb8eb61ab0c0da9ae90a2c1 Mon Sep 17 00:00:00 2001 From: Adrin Jalali Date: Fri, 26 Aug 2022 11:39:05 +0200 Subject: [PATCH 3/5] Update CONTRIBUTING.rst Co-authored-by: Benjamin Bossan --- CONTRIBUTING.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index f7a311a1..65d303d5 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -83,7 +83,7 @@ Releases are created using `manual GitHub workflows `_. As a maintainer, follow these steps: -1. Check and update the ``CHANGES.md`` +1. Check and update the ``docs/changes.rst`` 2. For a major release, create a new branch with the name "0.version.X", e.g. "0.2.X". This branch will have all tags for all releases under 0.2. 3. Bump the version defined in ``skops/__init__.py`` From 8dfca9c4be9cd7586422c393ce8f27c165a5576f Mon Sep 17 00:00:00 2001 From: adrinjalali Date: Fri, 26 Aug 2022 11:40:36 +0200 Subject: [PATCH 4/5] fix numbers --- CONTRIBUTING.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index f7a311a1..2cca36ab 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -93,18 +93,18 @@ As a maintainer, follow these steps: 6. Create a tag with the format "v0.version", e.g. "v0.2", and push it to the remote repository. Use this tag for releasing the package. If there is a minor release under the same branch, it would be "v0.2.1" for example. -6. Use the `GitHub action +7. Use the `GitHub action `__ to create a new release on **TestPyPI**. Check it for correctness `on test.pypi `_. -7. Use the `GitHub action +8. Use the `GitHub action `__ to create a new release on **PyPI**. Check it for correctness `pypi `_. -8. Create a `new release `_ on +9. Create a `new release `_ on GitHub -9. Update the patch version of the package to a new dev version, e.g. from +10. Update the patch version of the package to a new dev version, e.g. from ``v0.3.0`` to ``v0.3.dev1`` -10. Check that the new stable branch of documentation was built correctly on +11. Check that the new stable branch of documentation was built correctly on `readthedocs `_, and make sure all relevant releases are *active*. From 81cf4aee744b5fac16fb01d62351c6754be78d35 Mon Sep 17 00:00:00 2001 From: adrinjalali Date: Tue, 30 Aug 2022 13:42:20 +0200 Subject: [PATCH 5/5] add git grep --- CONTRIBUTING.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index c10a285e..03bc4a26 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -88,7 +88,13 @@ As a maintainer, follow these steps: "0.2.X". This branch will have all tags for all releases under 0.2. 3. Bump the version defined in ``skops/__init__.py`` 4. Git grep for any TODO's that need fixing before the release (e.g. - deprecations) + deprecations). You can do this, for example by: + + .. code:: bash + + git grep -n TODO + + 5. Create a PR with all the changes and have it reviewed and merged 6. Create a tag with the format "v0.version", e.g. "v0.2", and push it to the remote repository. Use this tag for releasing the package. If there is a