From a5321abbeb56071386d8def14ce2671478e89d54 Mon Sep 17 00:00:00 2001 From: Stephen Rosen Date: Wed, 30 Aug 2023 16:11:47 -0500 Subject: [PATCH] Bump version and changelog for release Also, document newer short-lived release branch process in the releasing doc. --- RELEASING.md | 48 +++++++++++-------- ...20230815_161655_sirosen_test_on_py3_12.rst | 4 -- ...rtmckee_surface_prompt_query_parameter.rst | 12 ----- ...4833_sirosen_complete_flow_run_example.rst | 4 -- changelog.d/20230822_155752_ada.rst | 5 -- ..._ada_add_inactive_timers_job_responses.rst | 4 -- docs/changelog.rst | 36 ++++++++++++++ src/globus_sdk/version.py | 2 +- 8 files changed, 66 insertions(+), 49 deletions(-) delete mode 100644 changelog.d/20230815_161655_sirosen_test_on_py3_12.rst delete mode 100644 changelog.d/20230818_072838_kurtmckee_surface_prompt_query_parameter.rst delete mode 100644 changelog.d/20230822_144833_sirosen_complete_flow_run_example.rst delete mode 100644 changelog.d/20230822_155752_ada.rst delete mode 100644 changelog.d/20230822_162223_ada_add_inactive_timers_job_responses.rst diff --git a/RELEASING.md b/RELEASING.md index 6eaac371b..79498c2f0 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -7,15 +7,19 @@ ## Procedure -- Make sure your repo is on `main` and up to date - -``` -git checkout main -git pull -``` +- Make sure your repo is on `main` and up to date; + `git checkout main; git pull` - Read `changelog.d/` and decide if the release is MINOR or PATCH + +- (optional) Set the version in the `SDK_VERSION` env var, for use in the + following steps. `SDK_VERSION=...` + +- Decide on the new version number and create a branch; + `git checkout -b release-$SDK_VERSION` + - Update the version in `src/globus_sdk/version.py` + - Update metadata and changelog, then verify changes in `changelog.rst` ``` @@ -23,25 +27,31 @@ make prepare-release $EDITOR changelog.rst ``` -- Add and commit changed files, then push to `main` +- Add changed files; + `git add changelog.d/ docs/changelog.rst src/globus_sdk/version.py` -``` -git add changelog.d/ docs/changelog.rst src/globus_sdk/version.py -git commit -m 'Bump version and changelog for release' -git push origin main -``` +- Commit; `git commit -m 'Bump version and changelog for release'` -- Tag the release. _This will run a workflow to publish to test-pypi._ +- Push the release branch; `git push -u origin release-$SDK_VERSION` -``` -make tag-release -``` +- Open a PR for review; + `gh pr create --base main --title "Release v$SDK_VERSION"` + +- After any changes and approval, merge the PR, checkout `main`, and pull; + `git checkout main; git pull` -- Create a GitHub release with a copy of the changelog. _This will run a workflow to publish to pypi._ +- Tag the release; `make tag-release` + _This will run a workflow to publish to test-pypi._ + +- Create a GitHub release with a copy of the changelog. + _This will run a workflow to publish to pypi._ Generate the release body by running ``` ./scripts/changelog2md.py ``` - -The name of the GitHub release should be `v$SDK_VERSION`. +or create the release via the GitHub CLI +``` +./scripts/changelog2md.py | \ + gh release create $SDK_VERSION --title "v$SDK_VERSION" --notes - +``` diff --git a/changelog.d/20230815_161655_sirosen_test_on_py3_12.rst b/changelog.d/20230815_161655_sirosen_test_on_py3_12.rst deleted file mode 100644 index 7c053659f..000000000 --- a/changelog.d/20230815_161655_sirosen_test_on_py3_12.rst +++ /dev/null @@ -1,4 +0,0 @@ -Python Support -~~~~~~~~~~~~~~ - -- Add support for Python 3.12. (:pr:`808`) diff --git a/changelog.d/20230818_072838_kurtmckee_surface_prompt_query_parameter.rst b/changelog.d/20230818_072838_kurtmckee_surface_prompt_query_parameter.rst deleted file mode 100644 index d17af062a..000000000 --- a/changelog.d/20230818_072838_kurtmckee_surface_prompt_query_parameter.rst +++ /dev/null @@ -1,12 +0,0 @@ -Added -~~~~~ - -- Add a ``prompt`` keyword parameter to ``AuthClient.oauth2_get_authorize_url()``. (:pr:`813`) - - Setting this parameter requires users to authenticate with an identity provider, - even if they are already logged in. Doing so can help avoid errors caused by - unexpected session required policies, which would otherwise require a second, - follow-up login flow. - - ``prompt`` could previously only be set via the ``query_params`` keyword parameter. - It is now more discoverable. diff --git a/changelog.d/20230822_144833_sirosen_complete_flow_run_example.rst b/changelog.d/20230822_144833_sirosen_complete_flow_run_example.rst deleted file mode 100644 index 4efd5b9da..000000000 --- a/changelog.d/20230822_144833_sirosen_complete_flow_run_example.rst +++ /dev/null @@ -1,4 +0,0 @@ -Documentation -~~~~~~~~~~~~~ - -- Add an example script which handles creating and running a **flow**. (:pr:`826`) diff --git a/changelog.d/20230822_155752_ada.rst b/changelog.d/20230822_155752_ada.rst deleted file mode 100644 index 25cc1bce5..000000000 --- a/changelog.d/20230822_155752_ada.rst +++ /dev/null @@ -1,5 +0,0 @@ -Added -~~~~~ - -- Add ``TimerClient.pause_job`` and ``TimerClient.resume_job`` for pausing and - resuming timers. (:pr:`827`) diff --git a/changelog.d/20230822_162223_ada_add_inactive_timers_job_responses.rst b/changelog.d/20230822_162223_ada_add_inactive_timers_job_responses.rst deleted file mode 100644 index 6c34b2b2f..000000000 --- a/changelog.d/20230822_162223_ada_add_inactive_timers_job_responses.rst +++ /dev/null @@ -1,4 +0,0 @@ -Development -~~~~~~~~~~~ - -- Added responses to ``_testing`` reflecting an inactive Timers job (:pr:`828`) diff --git a/docs/changelog.rst b/docs/changelog.rst index 0bbd6f073..a14a76619 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -12,6 +12,42 @@ to a major new version of the SDK. .. scriv-insert-here +.. _changelog-3.28.0: + +v3.28.0 (2023-08-30) +-------------------- + +Python Support +~~~~~~~~~~~~~~ + +- Add support for Python 3.12. (:pr:`808`) + +Added +~~~~~ + +- Add a ``prompt`` keyword parameter to ``AuthClient.oauth2_get_authorize_url()``. (:pr:`813`) + + Setting this parameter requires users to authenticate with an identity provider, + even if they are already logged in. Doing so can help avoid errors caused by + unexpected session required policies, which would otherwise require a second, + follow-up login flow. + + ``prompt`` could previously only be set via the ``query_params`` keyword parameter. + It is now more discoverable. + +- Add ``TimerClient.pause_job`` and ``TimerClient.resume_job`` for pausing and + resuming timers. (:pr:`827`) + +Documentation +~~~~~~~~~~~~~ + +- Add an example script which handles creating and running a **flow**. (:pr:`826`) + +Development +~~~~~~~~~~~ + +- Added responses to ``_testing`` reflecting an inactive Timers job (:pr:`828`) + .. _changelog-3.27.0: v3.27.0 (2023-08-11) diff --git a/src/globus_sdk/version.py b/src/globus_sdk/version.py index 683b67842..42d69b95d 100644 --- a/src/globus_sdk/version.py +++ b/src/globus_sdk/version.py @@ -1,3 +1,3 @@ # single source of truth for package version, # see https://packaging.python.org/en/latest/single_source_version/ -__version__ = "3.27.0" +__version__ = "3.28.0"