Skip to content

RELEASING.md

Latest commit

 

History

History
73 lines (43 loc) · 2.35 KB

RELEASING.md

File metadata and controls

73 lines (43 loc) · 2.35 KB
Raw

Releasing Raygun4Py

Raygun for Python is published on PyPi as raygun4py.

Semantic versioning

This package follows semantic versioning,

Given a version number MAJOR.MINOR.PATCH (x.y.z), increment the:

  • MAJOR version when you make incompatible changes
  • MINOR version when you add functionality in a backward compatible manner
  • PATCH version when you make backward compatible bug fixes

To learn more about semantic versioning check: https://semver.org/

Preparing for release

Release branch

Create a new branch named release/x.y.z where x.y.z is the Major, Minor and Patch release numbers.

Update version

Update the __version__ in the python3/raygun4py/version.py file.

Update CHANGELOG.md

Add a new entry in the CHANGELOG.md file. Keep the release marked Unreleased while it is under review, then replace Unreleased with the publication date in the final release commit.

Obtain a list of changes using the following git command:

git log --pretty=format:"- %s (%as)"

Commit and open a PR

Commit all the changes into a commit with the message chore: Release x.y.z where x.y.z is the Major, Minor and Patch release numbers.

Then push the branch and open a new PR, ask the team to review it.

Publishing

PR approval

Once the PR has been approved, you can publish the provider.

Before publishing, confirm that CI passes the unlocked Python compatibility matrix and the locked development job. If a test Raygun application is available, also run the functional tests described in CONTRIBUTING.MD.

Publish to PyPi

  1. Install build tools: pip install build
  2. Build the package: python -m build
  3. Check that the files dist/raygun4py-x.y.z.tar.gz and dist/raygun4py-x.y.z-py3-none-any.whl have been created.
  4. Install twine: pip install twine
  5. Check the package: twine check dist/*
  6. Upload to PyPi: twine upload dist/*
  7. Provide the API token when asked.
  8. Now the package is available for customers.

Merge PR to master

With the PR approved and the package published, squash and merge the PR into master.

Tag and create Github Release

Go to https://github.com/MindscapeHQ/raygun4py/releases and create a new Release.

GitHub will create a tag for you, you don't need to create the tag manually.

You can also generate the release notes automatically.