Skip to content

Publishing a new release

Jump to bottom
Aahnik Daw edited this page Jul 5, 2021 · 2 revisions

Note This page is for maintainers only

You can push from the command line (running make release), but that's not the recommended way.

It takes time to build and push packages. That will be a waste of your time.

If the tests have passed and everything is working as expected, just create a new release on GitHub. Building and pushing packages are fully automated via GitHub Actions.

Versioning

We should try to comply with semantic versioning and PEP 440.

Before creating a new release make sure that pyproject.toml is updated with the new version.

We are already on version 2. So all versions should preferably be 2.x.x. If there are breaking changes to the use of API, then the version should jump to 3.x.x.

Click on create a new release

image

Fill up the details in GitHub's UI and click "Publish release"

image

Notes:

Let's say that the version specified in pyproject.toml is X.y.z

  • The tag version should be vX.y.z (like v0.1.5)
  • The release title should be bhagavad-gita-api X.y.z.
  • The version should be different from the last version.
  • Don't forget to update the version in pyproject.toml. Otherwise, upload to PyPI will fail to raise "already exists".
  • The release description should act as a changelog. In the description of the release, the maintainer should write what bugs were fixed, what new features were added in that particular release.
  • When the maintainer hits "Publish release", GitHub Actions workflow will automatically push to PyPI and DockerHub.
Clone this wiki locally