release: 8.2

[oliver-sanders]

Release Progress

Issue to track the coordinated release of multiple Cylc components.

Required for all minor releases of cylc-flow.

See the release docs for first time instructions and more info.

Prep:

• The release lead should be assigned to this issue.
• Ensure all milestones complete.
• All bugfix branches should be merged into master.
• Ensure major changes are listed in cylc-doc (reference/changes).
• List the milestones for release below (delete entries as appropriate).

Testing:

Some testing is not fully automated and must be actioned by hand.

• Run cylc-flow functional tests against locally available platforms.
• cylc-doc (run a test build).
• cylc-rose (run the "tests" action).
• cylc-uiserver (run the "test" action).

Milestones for release:

The release actions close the milestones for you automatically.

• cylc-flow:
• cylc-ui:
• cylc-uiserver:
• rose:
• cylc-rose:
• cylc-doc:

PyPi / GitHub releases:

Ensure all Cylc components are pinned to the correct version of cylc-flow.

Trigger releases via GitHub actions.

(logical release order)

R1 = """
   cylc_flow & metomi_rose => cylc_rose
   cylc_flow & cylc_ui => cylc_uis
"""

Info on version pinning

Cylc plugins (i.e. cylc-rose and cylc-uiserver) are "pinned" to the minor version of cylc-flow. E.G. if the cylc-flow version is 8.1.2 the plugins should be pinned to 8.1.

More Information

• cylc-flow (bump metomi-isodatetime if required)
• cylc-ui
• cylc-uiserver ([update the ui via GH action first)
• rose
• cylc-rose

Forge (check dependencies match):

Pull requests will be automatically opened on the conda-forge feedstocks
after the pypi releases.

If the PR doesn't get opened automatically

Create a new branch, change the version, reset the build number and update the hash from the PyPi website.
Finally trigger a rerender in a comment.

Ensure dependencies are up to date and follow instructions on the PR. Some
repos may maintain a list of conda dependencies locally.

• cylc-flow
• cylc-ui NO!
• cylc-uiserver
• rose
• cylc-rose

It make take a couple of hours for a release to become available.
Use conda search <package> to determine when it's ready.

Misc (after the above has been completed):

• cylc-doc
  • bump intersphinx versions if required (cylc-doc/src/conf.py) update intersphinx version cylc-doc#630
  • review deployment instructions
  • deploy (run the "deploy" workflow on GitHub Actions) (can be re-deployed later if necessary)
• metomi-rose
  • build & deploy documentation (manual process ATM) 2.1.0 docs metomi/rose#2712
• discourse post

Metadata:

GH Actions should automatically open PRs that bump the dev version of the projects. Check and merge them (can push alterations to PR branch if needed).

Update cylc-admin with the new branches / meta-release (8.3):

• https://github.com/cylc/cylc-admin/blob/master/docs/status/branches.json

Pin downstream components to the next cylc-flow dev release:

• cylc-uiserver (pin cylc-flow to next upcoming version)
• cylc-rose (pin cylc-flow to next upcoming version)

Pin components in GH Actions tests:

• cylc-doc (update versions in .github/workflows/test.yml "install libs to document" step(s) as appropriate)

Finally:

• close this issue 🚀

[oliver-sanders]

Note:

• No metomi-rose release this time (all changes are sync / CI).
• cylc-rose 1.3.0 needs a sync, there is one outstanding issue on 1.2.1, we won't bother releasing 1.2.1 so please scrub this from the changelog.
• Please check all repos are upto sync with bugfix branches.
• There have been dependency changes, make sure you carefully check all setup.cfg and conda-environment.yml files match the conda-forge meta.yml files.

[wxtim]

No metomi-rose release this time (all changes are sync / CI).

I don't think that this is true: There are a number of fixes against rose 2.0.5 which we do want to release. Additionally Cylc Rose master has assumed that there would be a rose 2.1.0.

[MetRonnie]

(Unfortunately we released cylc-rose before noticing it had metomi-rose==2.1.*.)

Seeing as there were a couple of bugfixes on the rose 2.0.5 milestone we decided to merge 2.0.x into master and release rose 2.1.0 with those changes

[MetRonnie]

This ought to prevent that from happening again: cylc/release-actions#54

[wxtim]

bump intersphinx versions if required

This should have been bumped, but wasn't because the Rose docs aren't ready and changes are minor.