Skip to content

RELEASE.md

Latest commit

 

History

History
39 lines (30 loc) · 1.69 KB

RELEASE.md

File metadata and controls

39 lines (30 loc) · 1.69 KB

How to make a new Bempp-cl release

Updating the version number

You will need to update the version number in three places. These are:

We use the format {a}.{b}.{c} for the version numbers, where {a} should be increased for major releases, {b} should be increased for larger changes, and {c} should be increased for bugfixes and other minor changes.

Making the release on GitHub

Once the version numbers are updated on the main branch, you need to create a new release on GitHub. The release should be tagged v{a}.{b}.{c} with {a}, {b}, and {c} replaced with the three parts of the version number.

You should include a bullet pointed list of the main changes since the last version in the "Describe this release" section.

Updating bempp.com

Open a pull request to the bempp-website repo with the following changes:

  • Update bemppversion in the file _config.yml
  • Add the new version and release notes to changelog.md

Pushing to PyPI

Once a version is created on GitHub, the new version should automatically be pushed to PyPI by GitHub Actions. If this doesn't work, ask @mscroggs to look into why it's broken.

Updating the Conda package

A short time after the PyPI package is updated, a conda bot will open a pull request into the Bempp-cl conda feedstock repo. Once this is merged, the new version will be available via conda.