Skip to content

Conversation

@forsyth2
Copy link
Collaborator

@forsyth2 forsyth2 commented Oct 7, 2025

Summary

Objectives:

  • Bump to 1.5.0rc1

Select one: This pull request is...

  • a bug fix: increment the patch version
  • a small improvement: increment the minor version
  • a new feature: increment the minor version
  • an incompatible (non-backwards compatible) API change: increment the major version

Small Change

  • To merge, I will use "Squash and merge". That is, this change should be a single commit.
  • Logic: I have visually inspected the entire pull request myself.
  • Pre-commit checks: All the pre-commits checks have passed.

@forsyth2 forsyth2 added the Update version Code specifically to update the version label Oct 7, 2025
@forsyth2 forsyth2 merged commit bfa5cad into main Oct 7, 2025
5 checks passed
@forsyth2 forsyth2 deleted the v1.5.0rc1 branch October 7, 2025 18:35
@forsyth2
Copy link
Collaborator Author

forsyth2 commented Oct 7, 2025

Release process notes:

Step 1: testing

cd ~/ez/zstash
git status
# Check for uncommitted changes
git fetch upstream
git checkout -b test_zstash_main_20251007 upstream/main
git log
# Last commit: Update docutils constraint (#386)
# Good, matches https://github.com/E3SM-Project/zstash/commits/main/
# Good, hashes match
nersc_conda # Activate conda
conda clean --all --y
conda env create -f conda/dev.yml -n zstash_dev_20251007
conda activate zstash_dev_20251007
python -m pip install .

Now, we already took care of testing on 10/3: see #385 (comment) for full details. Perhaps during the E3SM Unified testing period, time permitting, we can make some improvements to the test suite itself.

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: zstash v1.4.4
  • E3SM Unified 1.11.1: zstash v1.4.4
  • E3SM Unified 1.12.0: zstash v1.5.0 (update to this)

Step 2b: zstash repo

git fetch upstream main
git checkout -b v1.5.0rc1 upstream/main
tbump 1.5.0rc1 --no-tag
# Error: conda/meta.yaml does not exist
# This was removed in https://github.com/E3SM-Project/zstash/pull/384/files
# In this case, let's just manually make the change...
# We'll match the changes from the last `rc1` PR -- https://github.com/E3SM-Project/zstash/pull/359
git grep -n "1\.4\.4" | cat
# setup.py:5:    version="1.4.4",
# tbump.toml:5:current = "1.4.4"
# zstash/__init__.py:1:__version__ = "v1.4.4"
#
# Yes, these match up with changes in https://github.com/E3SM-Project/zstash/pull/359
# Make changes
git add -A
pre-commit run --all-files
git commit -m "Bump to 1.5.0rc1"
git push upstream v1.5.0rc1
# Create, and "Update version" label" to, and merge https://github.com/E3SM-Project/zstash/pull/389
git fetch upstream
git checkout -b main  upstream/main
git tag -a v1.5.0rc1 -m "v1.5.0rc1"
# Delete the branch from the tbump step. Otherwise, the push command won't work.
git branch -D v1.5.0rc1
git push upstream v1.5.0rc1

v1.5.0rc1 now appears on Tags but not on Releases. Good, this is expected.

Step 2c: zstash-feedstock repo

cd /global/homes/f/forsyth/zstash-feedstock
curl -sL https://github.com/E3SM-Project/zstash/archive/v1.5.0rc1.tar.gz | openssl sha256
# SHA2-256(stdin)= 0deda016d8ba4fb5f4051d3a01516a3d38cc28dc7beb09ac54515955313d96e7
git status
# Check for uncommitted changes
git fetch upstream dev
git checkout -b v1.5.0rc1 upstream/dev
# recipe/meta.yaml doesn't match `main`: https://github.com/conda-forge/zstash-feedstock/blob/main/recipe/meta.yaml
# It does match `dev` though: https://github.com/conda-forge/zstash-feedstock/blob/dev/recipe/meta.yaml
#
emacs recipe.meta.yaml
# In `recipe/meta.yaml`, update the version and sha256 (and the build number if needed):
# {% set version = "1.5.0rc1" %}
# sha256: ... # The sha256 from the previous step
# number: 0 # build >>> number should always be 0
#
# Also appear to need to edit a number of dependency versions...
git add -A
git commit -m "v1.5.0rc1"
git push forsyth2 v1.5.0rc1

Created conda-forge/zstash-feedstock#16

@forsyth2
Copy link
Collaborator Author

forsyth2 commented Oct 7, 2025

@tomvothecoder

tbump 1.5.0rc1 --no-tag
# Error: conda/meta.yaml does not exist
# This was removed in https://github.com/E3SM-Project/zstash/pull/384/files

Should we have not removed conda/meta.yaml? I just ended up updating the versions manually instead of using tbump.

@tomvothecoder
Copy link
Collaborator

Should we have not removed conda/meta.yaml? I just ended up updating the versions manually instead of using tbump.

This line needs to be removed:

zstash/tbump.toml

Lines 31 to 32 in bfa5cad

[[file]]
src = "conda/meta.yaml"

@forsyth2 forsyth2 mentioned this pull request Oct 7, 2025
7 tasks
@forsyth2
Copy link
Collaborator Author

forsyth2 commented Oct 7, 2025

Thanks, see #390

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.

3 participants