@@ -256,7 +256,7 @@ The following notes are to remind the project maintainers and leads of the steps
256
256
review and merge PRs and to publish a new release.
257
257
258
258
Reviewing and Merging PRs
259
- ------------------------
259
+ -------------------------
260
260
261
261
- Make sure the PR description includes the `pull request template
262
262
<https://github.com/jazzband/django-oauth-toolkit/blob/master/.github/pull_request_template.md> `_
@@ -272,18 +272,25 @@ PRs that are incorrectly merged may (reluctantly) be reverted by the Project Lea
272
272
Publishing a Release
273
273
--------------------
274
274
275
- Only Project Leads can publish a release to pypi.org and rtfd.io. This checklist is a reminder
276
- of steps.
275
+ Only Project Leads can ` publish a release < https://jazzband.co/about/releases >`_ to pypi.org
276
+ and rtfd.io. This checklist is a reminder of the required steps.
277
277
278
278
- When planning a new release, create a `milestone
279
279
<https://github.com/jazzband/django-oauth-toolkit/milestones> `_
280
280
and assign issues, PRs, etc. to that milestone.
281
281
- Review all commits since the last release and confirm that they are properly
282
- documented in the CHANGELOG. (Unfortunately, this has not always been the case
283
- so you may be stuck documenting things that should have been documented as part of their PRs.)
282
+ documented in the CHANGELOG. Reword entries as appropriate with links to docs
283
+ to make them meaningful to users.
284
284
- Make a final PR for the release that updates:
285
285
286
286
- CHANGELOG to show the release date.
287
- - setup.cfg to set `version = ... `
288
-
289
- - Once the final PR is committed push the new release to pypi and rtfd.io.
287
+ - `oauth2_provider/__init__.py ` to set `__version__ = "..." `
288
+
289
+ - Once the final PR is merged, create and push a tag for the release. You'll shortly
290
+ get a notification from Jazzband of the availability of two pypi packages (source tgz
291
+ and wheel). Download these locally before releasing them.
292
+ - Do a `tox -e build ` and extract the downloaded and bullt wheel zip and tgz files into
293
+ temp directories and do a `diff -r ` to make sure they have the same content.
294
+ (Unfortunately the checksums do not match due to timestamps in the metadata
295
+ so you need to compare all the files.)
296
+ - Once happy that the above comparison checks out, approve the releases to Pypi.org.
0 commit comments