Merge pull request #850 from sirosen/release-3.28.0

Release v3.28.0

RELEASING.md

@@ -7,41 +7,51 @@
 
 ## 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`
 
 ```
 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 -
+```

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)

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"