release: 8.1.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.
• Ensure major changes are listed in cylc-doc (reference/changes).
• Test cylc-doc (run a test build, perform any required fixes).
• Run cylc-flow functional tests against locally available platforms.
• List the milestones for release below (delete entries as appropriate).

Milestones for release:

The release actions close the milestones for you automatically.

• cylc-flow:
• cylc-ui:
• cylc-uiserver:
• 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

• metomi-isodatetime
• 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.

• metomi-isodatetime
• cylc-flow
• cylc-ui
• 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)
• 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).

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)
• metomi-rose (update versions in .github/actions/install-libs as appropriate)

Finally:

• close this issue 🚀

[oliver-sanders]

metomi-rose

There are no functional changes against the 2.0.3 or 2.1.0 milestones so there is no need to release either. We can pin cylc-rose against the pre-existing metomi-rose 2.0.* and cylc-flow 8.1.*.

Removed metomi-rose from the release milestones.

cylc-rose

We do not need the 1.1.2 release so we can skip straight to 1.2.0.

cylc-uiserver

We do not need the 1.1.1 release so we can skip straight to 1.2.0.

[wxtim]

@oliver-sanders - any reason why this issue is still open?

[oliver-sanders]

The unchecked boxes weren't completed until very recently.