release: 8.4.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.
• List the milestones for release below (delete entries as appropriate).
• All bugfix branches should be merged into master.
• Ensure all milestones complete.
• Ensure major changes are listed in cylc-doc (reference/changes).

Testing:

Some testing is not fully automated and must be actioned by hand. Make sure
the tests for downstream components have been run against the latest
version of upstream repositories.

• Run cylc-flow functional tests against locally available platforms.

  • Slurm
    

• cylc-doc (run a test build) - Workflow Run.

• cylc-rose (run the "tests" action) - Workflow Run.

• cylc-uiserver (run the "test" action) - Workflow Run

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 = """
   metomi_isodatetime => 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

Open a new issue on the feedstock repository, select the "bot command" issue type and set the title to `@conda-forge-admin, please update version`.

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

If you need to make changes, remember to re-render the feedstock
by commenting @conda-forge-admin, please rerender on the PR.

• metomi-isodatetime
• 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):

• metomi-rose
  • build & deploy documentation (manual process ATM)
• 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)
• 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.

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

Downstream components will need to have their dependencies bumped:

• cylc-uisever (pin to next minor cylc-flow version)
• cylc-rose (pin to next minor cylc-flow and metomi-rose versions)

Finally:

• close this issue 🚀