release: 8.3.0

[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) - https://github.com/cylc/cylc-doc/actions/runs/9563076562.
• cylc-rose (run the "tests" action) - https://github.com/cylc/cylc-rose/actions/runs/9562550867.
• cylc-uiserver (run the "test" action) - https://github.com/cylc/cylc-uiserver/actions/runs/9564529603.

Milestones for release:

The release actions close the milestones for you automatically.

• cylc-flow:
• cylc-ui:
• cylc-uiserver:
• metomi/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)
• metomi-rose (bump metomi-isodatetime if required)
• 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-uiserver
• metomi-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)
  • 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.3.0 docs metomi/rose#2792
• Discourse
  • announce the release
  • scan through the major changes page
    and create "tip" posts (linking back to the changes page) to announce any new features.
  • add a link to interventions docs in response to interventions cylc-doc#626

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

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)

Finally:

• close this issue 🚀

[oliver-sanders]

Kicked off cylc-doc test run: https://github.com/cylc/cylc-doc/actions/runs/9562311263/job/26358424632

Expecting failure from the look of the nightlies :(

Fixes:

• spelling: add vip to the dictionary cylc-doc#741
• xtriggers: doc change cylc-flow#6152
• exclude matrix addresses with # from linkcheck cylc-doc#743

Kicked off new run: https://github.com/cylc/cylc-doc/actions/runs/9563076562

Passed.

[oliver-sanders]

metomi-rose pypi release appeared to fail with server errors (500 codes) in CI output, however, the release actually succeeded. Ronnie has manually created a GitHub release to match.

[oliver-sanders]

Pushed cylc-doc 8.3.0 tag, waiting for metomi-rose docs deployment (required for intersphinx) before deploying cylc-doc.

[oliver-sanders]

cylc-doc deployment run started: https://github.com/cylc/cylc-doc/actions/runs/9580385016/job/26414898246

success

[oliver-sanders]

The two unchecked boxes are about Discourse "tip" announcements which we will trickly through in the coming weeks.

Posted to Element.