Skip to content

Publishing changes to PyPI

Jump to bottom
Derek Fujimoto edited this page Sep 3, 2021 · 1 revision

Changes made to the git repository are not made available via PyPI until they are distributed. Here are the steps one is expected to take to push your changes to to PyPI and make them available to users via the pip command.

  1. Push all commits to the github repository

  2. Change the version number in global_variables.py according to the semantic versioning rules. In short:

    • Patch version Z (x.y.Z | x > 0) MUST be incremented if only backwards compatible bug fixes are introduced.
    • Minor version Y (x.Y.z | x > 0) MUST be incremented if new, backwards compatible functionality is introduced to the public API. It MUST be incremented if any public API functionality is marked as deprecated. It MAY be incremented if substantial new functionality or improvements are introduced within the private code. It MAY include patch level changes. Patch version MUST be reset to 0 when minor version is incremented.
    • Major version X (X.y.z | X > 0) MUST be incremented if any backwards incompatible changes are introduced to the public API. It MAY also include minor and patch level changes. Patch and minor versions MUST be reset to 0 when major version is incremented.

  3. Commit this change as the version number, vx.y.z, to help track changes in the commit history

  4. Make a new release tagged as the semantic version number, and the title "mudpy".

    • Please include a list of changes since the last release (click on last release to see a list of commits since that version)

Upon the publication of this release, a workflow has been set up to push that version to PyPI. You can see if this has been successful under the Actions tab.

Clone this wiki locally