Skip to content

release-process.md

Latest commit

 

History

History
58 lines (35 loc) · 2.03 KB

release-process.md

File metadata and controls

58 lines (35 loc) · 2.03 KB

The ocean.py Release Process

Step 0: Update documentation

This doesn't actually affect the pip release of the following steps. And if you've just updated READMEs, you can stop after this step if you like.

Step 1: Bump version and push changes

  • Create a new local feature branch, e.g. git checkout -b feature/bumpversion-to-v1.2.5

  • Use the bumpversion.sh script to bump the project version. You can execute the script using {major|minor|patch} as first argument to bump the version accordingly. Ocean.py is SEMVER compatible.

    • To bump the patch version: ./bumpversion.sh patch
    • To bump the minor version: ./bumpversion.sh minor
    • To bump the major version: ./bumpversion.sh major

  • Commit the changes to the feature branch.

    git commit -m "Bump version <old_version> -> <new_version>"

  • Push the feature branch to GitHub.

    git push origin feature/bumpversion-to-v1.2.5"

Step 2: Merge changes to v4main branch

  • Make a pull request from the just-pushed branch.

  • Wait for all the tests to pass!

  • Merge the pull request into the v4main branch.

Step 3: Release

  • To make a GitHub release (which creates a Git tag):

    • Go to the ocean.py repo's Releases page https://github.com/oceanprotocol/ocean.py/releases
    • Click "Draft a new release".
    • For tag version, put something like v1.2.5
    • For release title, put the same value (like v1.2.5).
    • For the target, select the v4main branch, or the just-merged commit.
    • Describe the main changes. (In the future, these will come from the changelog.)
    • Click "Publish release".

Step 4: Verifiy