Skip to content

Latest commit

 

History

History
31 lines (28 loc) · 1.23 KB

File metadata and controls

31 lines (28 loc) · 1.23 KB

Version Release Process

  1. Open a PR with the following changes:

    1. Bump the version in pyproject.toml.
    2. Update the CHANGELOG.md.
    3. If the change requires a newer Code Ocean server version, update MIN_SERVER_VERSION in client.py.
    4. Commit the updates with the message Bump version to X.Y.Z.
  2. Review, approve, and merge the PR. This is a manual step performed by a human after CI passes — it is the approval gate for the release.

    ⚠️ Automated agents: stop after step 1. Open the release PR, then hand control back to the user. A human performs this step. Do not merge the PR, create the tag, or push the tag on your own — pushing the tag publishes to PyPI and cannot be undone. Only continue to the steps below after the user explicitly tells you to proceed.

  3. Locally, sync your clone with GitHub:

    git fetch origin
    git checkout main
    git reset --hard origin/main
    
  4. Tag the release:

    git tag vX.Y.Z -m "vX.Y.Z"
    
  5. Push changes:

    git push origin vX.Y.Z
    

    This will trigger a workflow on CircleCI that will publish the new version to PyPI.