Skip to content

Commit

Permalink
Update release documentation and pipelines config
Browse files Browse the repository at this point in the history
pipelines will force push over github

steps for uploading to pypi are now labelled as deployments
  • Loading branch information
cetanu committed Oct 24, 2024
1 parent 73649a0 commit 2eadb44
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 16 deletions.
42 changes: 27 additions & 15 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,42 +4,54 @@ Release Process
Making changes
--------------
Contributors should create a new branch from the `master` branch for any new
features or bug fixes.
features or bug fixes

Once the changes are complete, open a pull-request, have it reviewed, merge the
branch back into `master`.
Once the changes are complete:

Remember to write a good commit message including a body, and add it to [CHANGELOG.md].
* Write a good commit message, including a body
* Add your changes to [CHANGELOG.md]
* Increment the appropriate version in [pyproject.toml]
* Open a pull-request, have it reviewed
* Merge the branch back into `master`


Releasing a new major/minor version
-----------------------------------
When it is time to release the version, checkout `master` and create a new
branch named `release/<version>` without the patch number. For example, `release/0.29`.
branch named `release/<version>` without the patch number. For example, `release/0.29`

Don't forget to increment the version in [pyproject.toml] and update [CHANGELOG.md].

Do not merge the branch back into `master`.
Do not merge the branch back into `master`


Upload to PyPI
--------------
⚠️ Warning: once a release has been uploaded to PyPI it cannot be deleted
without manual action by the package maintainer.
without manual action by the package maintainer

Create & push a tag on the last commit in the `release/<version>` branch

Create & push a tag on the last commit in the `release/<version>` branch.

Patch process
-------------
Follow the above process, but check out the specific `release/<version>` branch
that requires the patch, instead of `master`.
that requires the patch, instead of `master`

You will still need to create a new branch from this release branch for the
patch, and open a pull-request to merge onto the `release/<version>` branch
that you checked out.
that you checked out

If a security patch is required, apply the same patch to the last 5 minor
versions by checking out each release branch.
versions by checking out each release branch


Release cadence / schedule
--------------------------
To be determined, no schedule as yet. Realistically, after there is a
significant batch of changes that have been tested in our internal environment
for some time and seem stable

If development picks up and many changes are backed up, we will set a regular
release cadence


Example workflows
Expand Down Expand Up @@ -84,5 +96,5 @@ Example workflows

Important Notes
---------------
- **Versioning**: Follow [semver](https://semver.org) for naming your release and patch versions.
- **Documentation**: Update any relevant documentation in [sovereign-docs](https://bitbucket.org/atlassian/sovereign-docs).
- **Versioning**: Follow [semver](https://semver.org) for naming your release and patch versions
- **Documentation**: Update any relevant documentation in [sovereign-docs](https://bitbucket.org/atlassian/sovereign-docs)
4 changes: 3 additions & 1 deletion bitbucket-pipelines.yml
Original file line number Diff line number Diff line change
Expand Up @@ -113,11 +113,12 @@ pipelines:
- git remote add github [email protected]:cetanu/sovereign.git
- git fetch --unshallow github
- git branch --set-upstream-to master
- git push --set-upstream github master
- git push --set-upstream --force github master
tags:
'*.*.*':
- step:
name: Release to PyPI
deployment: release
caches: [pip]
script:
- *set_environment
Expand All @@ -128,6 +129,7 @@ pipelines:
'*.*.*rc*': &prerelease
- step:
name: Pre-release to PyPI
deployment: prerelease
caches: [pip]
script:
- *set_environment
Expand Down

0 comments on commit 2eadb44

Please sign in to comment.