Bump to 3.1.0

[forsyth2]

Bump to 3.1.0

[forsyth2]

Providing a reference for future production releases. Here are the steps completed for this release:

Production release of zppy v3.1.0

References:

• Somewhat outdated docs, on how to make a release: https://docs.e3sm.org/zppy/_build/html/main/dev_guide/release.html
• Notes from releasing v3.1.0rc3: Bump to 3.1.0rc3 #754

Step 1: setup/testing

cd ~/ez/zppy
git status
# branch test-diags-pr1016-1018
# We're in the middle of testing https://github.com/E3SM-Project/e3sm_diags/pull/1016 & https://github.com/E3SM-Project/e3sm_diags/pull/1018
# We've determined it's ok to proceed with the `zppy` release since we're confident the version pinning of #1018 fixes the issues. in `e3sm_diags`.

# Clear up the workspace to proceed with the release:
git add -A
git commit -m "Testing" --no-verify

We can skip the testing step, since that has been thoroughly covered:

• chrysalis
• compy
• perlmutter

Step 2: Bump versions

Step 2a: Confluence

Update https://e3sm.atlassian.net/wiki/spaces/DOC/pages/129732419/Packages+in+the+E3SM+Unified+conda+environment:

• E3SM Unified 1.11.0: zppy v3.0.0
• E3SM Unified 1.11.1: zppy v3.0.0
• E3SM Unified 1.12.0: zppy v3.1.0 (We updated this when we made rc1)

Step 2b: zppy-interfaces repo

Bumping the Version

git fetch upstream main
git checkout -b v3.1.0 upstream/main
git log
# Update active settings in test cfg (#758)
# Multithread image tests (#752)
# Fixes for rc4 (#755)
# Bump to 3.1.0rc3 (#754)

# Good, matches https://github.com/E3SM-Project/zppy/commits/main/

# Set up conda so we can use tbump:
lcrc_conda # Activate conda
rm -rf build
conda clean --all --y
conda env create -f conda/dev.yml -n zppy_prod_release_20251120
conda activate zppy_prod_release_20251120
python -m pip install .

tbump 3.1.0 --no-tag
git log
# Last commit: Bump to 3.1.0
# Creates commit, but doesn't push it (because branch isn't named `main`)
git push upstream v3.1.0
# Follow recent RCs as examples:
# rc1: https://github.com/E3SM-Project/zppy/pull/740
# rc2: https://github.com/E3SM-Project/zppy/pull/750
# rc3: https://github.com/E3SM-Project/zppy/pull/754
# Set myself as author, set the label as "Update version"
# Merge https://github.com/E3SM-Project/zppy/pull/759

Releasing on GitHub: production releases

Follow steps outlined here:

1. Draft a new release here. You can save this and come back to it later, if need be.
   • Click "Draft a new release".
2. Set Tag version to v3.1.0, including the “v”. @Target should be main.
   • Tag > Create new tag > v.3.1.0
3. Set Release title to v3.1.0, including the “v”.
4. Use "Describe this release" to summarize the changelog.
   • Copy draft of release notes to here.
5. Make sure "Set as the latest release" is checked.
6. Click Publish release.
   • Tag created here.
   • Unlike the RCs, v3.1.0 now appears on both Tags and Releases.
7. CI/CD release workflow is automatically triggered.
   • https://github.com/E3SM-Project/zppy/actions/runs/19555492212 is just for the docs. Clicking "Publish release" is responsible for triggering the bot PR on conda-forge.

Step 2c: zppy-interfaces-feedstock repo

Releasing on conda-forge: production releases

Follow steps outlined here:

1. Wait for a bot PR to come up automatically on conda-forge after the GitHub release. This can happen anywhere from 1 hour to 1 day later. (Alternative: open an issue with the bot command: @conda-forge-admin, please update version and the PR will opened.)
   • Check https://github.com/conda-forge/zppy-feedstock/pulls
   • See zppy v3.1.0 conda-forge/zppy-feedstock#33
2. Complete any requirements to merge the PR.
3. Check the https://anaconda.org/conda-forge/zppy/files/manage page to view the newly updated package. Check it has the main label.