Skip to content

Bump to 3.2.0#826

Merged
forsyth2 merged 1 commit into
mainfrom
v3.2.0
May 14, 2026
Merged

Bump to 3.2.0#826
forsyth2 merged 1 commit into
mainfrom
v3.2.0

Conversation

@forsyth2
Copy link
Copy Markdown
Collaborator

Bump to 3.2.0

@forsyth2 forsyth2 self-assigned this May 14, 2026
@forsyth2 forsyth2 added the Update version Code specifically to update the version label May 14, 2026
@forsyth2 forsyth2 merged commit 17ce933 into main May 14, 2026
7 checks passed
@forsyth2 forsyth2 deleted the v3.2.0 branch May 14, 2026 19:52
@forsyth2
Copy link
Copy Markdown
Collaborator Author

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

Production release of zppy v3.2.0

References:

Step 1: setup/testing

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

Prepare documentation

# On Perlmutter
cd ~/ez/zppy
git status # Confirm there's no uncommitted changes
git fetch upstream main
git checkout -b prepare-docs-for-3.2.0 upstream/main

See this release's parameter defaults <https://github.com/E3SM-Project/zppy/blob/bfbba5f9c3794cd7e399e35f8153866b1c8f6910/zppy/defaults/default.ini>_
on GitHub for a complete list of parameters and their default values.
You can also view the most up-to-date,
unreleased parameter defaults <https://github.com/E3SM-Project/zppy/blob/main/zppy/templates/default.ini>_.

Let's replace that hash with the latest commit hash. From https://github.com/E3SM-Project/zppy/commits/main, that's 885d53cb989119d77a21b4f25fe6109fc74a043e.

git add -A
nersc_conda # Activate conda
conda env list # Just pick any zppy dev env
conda activate zppy-fixes-of-rc8-20260505 
pre-commit run --all-files # Passes
git commit -m "Update parameter documentation pointer for v3.2.0"
git push upstream prepare-docs-for-3.2.0

Create, mark myself as assignee, add Documentation label, merge, delete GitHub branch: #825

Step 2: Bump versions

Step 2a: Confluence

Confirm version numbers are correct on https://e3sm.atlassian.net/wiki/spaces/DOC/pages/129732419/Packages+in+the+E3SM+Unified+conda+environment:

  • E3SM Unified 1.12.0: zppy v3.1.0
  • E3SM Unified 1.13.0: zppy v3.2.0

Step 2b: zppy repo

Bumping the Version

# On Perlmutter
cd ~/ez/zppy
git status # Confirm there's no uncommitted changes
git fetch upstream main
git checkout -b v3.2.0 upstream/main
git log --oneline | head -n 3
# c3288469 Update parameter documentation pointer for v3.2.0 (#825)
# 885d53cb Fix image checker (#818)
# f368ab71 Bump to 3.2.0rc2 (#816)

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

tbump 3.2.0 --no-tag
# Error: Command `git push upstream main` failed
# That only fails because we're not on the main branch
git log --oneline | head -n 1
# 46481a2a Bump to 3.2.0

# It did make a commit, we just need to push it.
git push upstream v3.2.0

# Create, add "Update version" label" to: https://github.com/E3SM-Project/zppy/pull/826

# Compare https://github.com/E3SM-Project/zppy/pull/826/changes with rc2's diff:
# https://github.com/E3SM-Project/zppy/pull/816/changes
# Looks good

# Wait for CI checks to pass, merge, delete GitHub branch: https://github.com/E3SM-Project/zppy/pull/826

Releasing on GitHub: production releases

  1. Draft a new release here.
    • Click "Draft a new release".
  2. Set Tag version to v3.2.0, including the “v”. @Target should be main.
    • Tag > Create new tag > v.3.2.0
  3. Set Release title to v3.2.0, including the “v”.
  4. Use Describe this release to summarize the changelog.
    • "Summary of changes": The high-level summary
    • "Full list of changes": The categorized log of commits
  5. Make sure "Set as the latest release" is checked.
  6. Click Publish release.
    • Tag created here.
    • Unlike the RCs, v3.2.0 now appears on both Tags and Releases.
  7. CI/CD release workflow is automatically triggered.
    • docs workflow is just for the docs. Clicking "Publish release" is responsible for triggering the bot PR on conda-forge.

Step 2c: zppy-feedstock repo

Releasing on conda-forge: production releasess

TODO: wait for the bot PR

  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.)
  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.

Step 2d: documentation

The docs workflow completed successfully. If we go to https://docs.e3sm.org/zppy/_build/html/main/parameters.html, and click on "this release’s parameter defaults", we do in fact go to the new hash link.

@forsyth2
Copy link
Copy Markdown
Collaborator Author

Relevant conda-forge PR: conda-forge/zppy-feedstock#38

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Update version Code specifically to update the version

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant