Library Release Checklist

Here is a process checklist for Bytewax employees to release a new version of the Python library. Contributors do not need to follow the steps within and instead should follow the instructions in Contribution Guide.

1. One Final PR

Make a PR which commits the following:

1. Bumps version number in Cargo.toml

   *** Cargo.toml
    [package]
   -version = "0.1.0"
   +version = "1.2.3"
   

2. Commits updated stubs

   (.venv) bytewax/ $ maturin develop -E dev
   (.venv) bytewax/ $ python stubgen.py bytewax._bytewax -o pysrc/bytewax/_bytewax.pyi
   (.venv) bytewax/ $ ruff format pysrc/bytewax/_bytewax.pyi
   

   If there was no change to any of our PyO3 Rust API, there might be no changes to commit here. People also should be committing these changes in the actual feature PRs.

3. Labels the latest changelog entries with the version number

   Look in CHANGELOG.md for the latest batch of hand-written changelog notes and add a new headings with the version number.

   *** CHANGELOG.md
    ## Latest
   
    __Add any extra change notes here and we'll put them in the release
    notes on GitHub when we make a new release.__
   
   +## 1.2.3
   +
    * Example note here. Describe any super important changes that you
      wouldn't glean from PR names which will be added by GitHub
      automatically.
   

4. Write migration guide entry

   Add a section to docs/user_guide/reference/migration.md like

   ## From v1.2.2 to v1.2.3
   
   ### Breaking change to Cow API
   
   The `Cow` API is now named `Bear`.
   
   If you had code that looked like this
   
   % skip: next
   
   ```python
   from bytewax.dataflow import OldFlow
   
   flow = OldFlow()
   ```
   
   It now is should be written as
   
   ```python
   from bytewax.dataflow import Dataflow
   
   flow = Dataflow("flow_id")
   ```
   

   Then add sub-sections for each of the breaking changes with before and after example code.

Then check before merging:

1. Confirm CI tests pass.

2. Confirm that the documentation for this build renders correctly: go to the list of actions at the bottom of the PR, and click on the Details link next to the last docs/readthedocs.org:bytewax entry.

Approve and merge that PR.

Check that the CI run completed for the just updated main branch on our CI actions page](https://github.com/bytewax/bytewax/actions/workflows/CI.yml) after merging the PR.

3. Create Release on GitHub

Go to the create a new GitHub release page for our repo.

1. Choose a tag and enter a tag with the new version number v1.2.3.

2. Click “Auto-generate release notes”.

   This will pre-populate the GitHub release notes with a list of changes via PRs.

3. Copy and paste any hand-written notes from the section of CHANGELOG.md with this version into a new section of the GitHub release description at the top.

   +## Overview
   +* Paste in the stuff in `CHANGELOG.md` here.
   +
    ## What's Changed
    * List of PRs that were merged, but sometimes the names aren't helpful.
   

4. Wait until the CI run above for the main branch completes. The next CD step needs the wheel packages that are built during CI. It looks like this usually takes ~20 min.

5. Press “Publish release”!

   This should create a tag in our repo named v1.2.3 and CD will kick off, pushing the final package to PyPI.

   Check that the CD run completed on our CD actions page.

3. Double check PyPI

Double check our Bytewax PyPI page to make sure that the new version of the package is there.

4. Double check ReadTheDocs

We host our docs at https://docs.bytewax.io which are hosted by Read The Docs. The RTD project should automatically detect that a new tag was created and build the documentation from that tag, through the automation rules setup here.

Double check that the build for this new version completed at the builds page for our project. Then go to our live production docs and ensure that the new release docs are being shown for the stable version.

I think we’re done! Update this if we’re not!