-
-
Notifications
You must be signed in to change notification settings - Fork 546
Release process
Releases are handled by a Github Action Workflow, the status can be seen at the Actions section.
The action is triggered when a new Release is made public, but first the release needs to be properly marked in the code and CHANGELOG.md file, this must be done by opening a Release PR
.
Follow this steps to prepare a new release:
-
Edit
__init__.py
(for examplesocial_core/__init__.py
/social_django/__init__.py
) and update the release number in that module -
Edit
CHANGELOG.md
, include missing changelog entries and update theUnreleased
header with the release and proper tag link and date, for social-core it could look like:From:
## [Unreleased](https://github.com/python-social-auth/social-core/)
To:
## [4.0.2](https://github.com/python-social-auth/social-core/releases/tag/4.0.2) - 2021-01-10
-
Commit your changes with a commit message similar to:
Version bump 4.0.2
-
Open a pull-request against
master
with a title similar to:Release 4.0.2
and fill the needed fields in the PR template
-
Request a review from the team by mentioning
@python-social-auth/maintainers
in the comments
When merged, somebody in the team needs to issue the release by:
- Go to Releases
- Click the
Draft a new release
button - Fill the tag (
4.0.2
) in theTag version
input - Fill the title (
Release 4.0.2
) in theRelease title
input - Copy and paste the changelog section corresponding to the current release as the description
- Publish it
You can monitor the release action at the link mentioned above.