Merge pull request #6679 from cylc/8.4.x-sync

🤖 Merge 8.4.x-sync into master

Author: oliver-sanders

.github/workflows/1_create_release_pr.yml

@@ -11,6 +11,19 @@ on:
         required: false
         default: 'master'
 
+concurrency:
+  # Only let this run 1 at a time
+  group: ${{ github.workflow }}
+  cancel-in-progress: false
+
+defaults:
+  run:
+    shell: bash
+
+env:
+  FORCE_COLOR: 2
+  PIP_PROGRESS_BAR: off
+
 jobs:
   create-release-pr:
     runs-on: ubuntu-latest

.github/workflows/2_auto_publish_release.yml

@@ -7,7 +7,18 @@ on:
     # NOTE: While this is too generic, we use the `if` condition of the job to narrow it down
     # NOTE: Don't use `branches` as we might create release on any branch
 
+concurrency:
+  # Only let this run 1 at a time
+  group: ${{ github.workflow }}
+  cancel-in-progress: false
+
+defaults:
+  run:
+    shell: bash
+
 env:
+  FORCE_COLOR: 2
+  PIP_PROGRESS_BAR: off
   # Best not to include the GH token here, only do it for the steps that need it
   MERGE_SHA: ${{ github.event.pull_request.merge_commit_sha }}
   CHANGELOG_FILE: CHANGES.md

.github/workflows/bash.yml

@@ -31,6 +31,14 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
+defaults:
+  run:
+    shell: bash
+
+env:
+  FORCE_COLOR: 2
+  PIP_PROGRESS_BAR: off
+
 jobs:
   bash-docker:
     runs-on: ubuntu-latest

.github/workflows/build.yml

@@ -10,6 +10,20 @@ on:
       - 'MANIFEST.in'     # check packaging
       - 'pyproject.toml'  # check build config
       - 'setup.cfg'       # check deps and project config
+      - '.gitignore'
+      - '.github/workflows/build.yml'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+defaults:
+  run:
+    shell: bash -leo pipefail {0}
+
+env:
+  FORCE_COLOR: 2
+  PIP_PROGRESS_BAR: off
 
 jobs:
   test:
@@ -18,29 +32,31 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: ['ubuntu-latest']
-        python: ['3.8', '3.9', '3.10', '3.11']
-        include:
-          - os: 'ubuntu-22.04'
-            python: '3.7'
+        os: ['ubuntu-latest', 'macos-latest']
+        python: ['3.7', '3.8', '3.9', '3.10', '3']
+        exclude:
           - os: 'macos-latest'
-            python: '3.8'
+            python: '3.7'
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
       - name: Setup Python
-        uses: actions/setup-python@v5
+        uses: mamba-org/setup-micromamba@v2
         with:
-          python-version: ${{ matrix.python }}
+          cache-environment: true
+          post-cleanup: 'all'
+          environment-name: cylc-build
+          create-args: >-
+            python=${{ matrix.python }}
 
       - name: Build
         uses: cylc/release-actions/build-python-package@v1
 
       - name: Inspect
         run: |
           unzip -l dist/*.whl | tee files
-          grep 'cylc_flow.*.dist-info/COPYING' files
+          grep -E 'cylc_flow.*.dist-info/.*COPYING' files
           grep 'cylc/flow/py.typed' files
           grep 'cylc/flow/etc' files
           grep 'cylc/flow/etc/cylc-completion.bash' files

.github/workflows/test_conda-build.yml

@@ -13,6 +13,13 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
+defaults:
+  run:
+    shell: bash
+
+env:
+  FORCE_COLOR: 2
+
 jobs:
   test_conda_install:
     if: github.repository_owner == 'cylc' || github.event_name != 'schedule'

.github/workflows/test_fast.yml

@@ -16,6 +16,9 @@ defaults:
   run:
     shell: bash -c "exec $CONDA_PREFIX/bin/bash -elo pipefail {0}"
 
+env:
+  PIP_PROGRESS_BAR: off
+
 jobs:
   test:
     runs-on: ${{ matrix.os }}
@@ -32,11 +35,9 @@ jobs:
           - os: 'ubuntu-latest'
             python-version: '3.9'  # not the oldest, not the most recent version
             time-zone: 'XXX-09:35'
-
     env:
       TZ: ${{ matrix.time-zone }}
       PYTEST_ADDOPTS: --cov --cov-append -n 5 --color=yes
-
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -106,6 +107,8 @@ jobs:
     strategy:
       matrix:
         python-version: ['3']
+    env:
+      FORCE_COLOR: 2
     steps:
       - name: Checkout
         uses: actions/checkout@v4

.github/workflows/test_functional.yml

@@ -36,6 +36,10 @@ defaults:
   run:
     shell: bash -c "exec $CONDA_PREFIX/bin/bash -elo pipefail {0}"
 
+env:
+  FORCE_COLOR: 2
+  PIP_PROGRESS_BAR: off
+
 jobs:
   test:
     runs-on: ${{ matrix.os }}

.github/workflows/test_tutorial_workflow.yml

@@ -17,6 +17,14 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
+defaults:
+  run:
+    shell: bash
+
+env:
+  FORCE_COLOR: 2
+  PIP_PROGRESS_BAR: off
+
 jobs:
   test:
     strategy:

changes.d/6623.fix.md

@@ -0,0 +1,3 @@
+Auto restart: The option to condemn a host in "force" mode (that tells
+workflows running on a server to shutdown as opposed to migrate) hasn't worked
+with the host-selection mechanism since Cylc 8.0.0. This has now been fixed.

cylc/flow/cfgspec/globalcfg.py

@@ -826,16 +826,52 @@ def default_for(
                    range.
             ''')
             Conf('condemned', VDR.V_ABSOLUTE_HOST_LIST, desc=f'''
-                These hosts will not be used to run jobs.
+                List run hosts that workflows should *not* run on.
 
-                If workflows are already running on
-                condemned hosts, Cylc will shut them down and
-                restart them on different hosts.
+                These hosts will be subtracted from the
+                `available <global.cylc[scheduler][run hosts]>` hosts
+                preventing new workflows from starting on the "condemned" host.
+
+                Any workflows running on these hosts will either migrate
+                to another host, or shut down according to
+                :py:mod:`the configuration <cylc.flow.main_loop.auto_restart>`.
+
+                This feature requires ``auto restart`` to be listed
+                in `global.cylc[scheduler][main loop]plugins`.
+
+                For more information, see the
+                :py:mod:`auto restart <cylc.flow.main_loop.auto_restart>`
+                plugin.
+
+                .. rubric:: Example:
+
+                .. code-block:: cylc
+
+                   [scheduler]
+                       [[main loop]]
+                           # activate the "auto restart" plugin
+                           plugins = auto restart
+                       [[run hosts]]
+                           # there are three hosts in the "pool"
+                           available = host1, host2, host3
+
+                           # however two have been taken out:
+                           # * workflows running on "host1" will attempt to
+                           #   restart on "host3"
+                           # * workflows running on "host2" will shutdown
+                           condemned = host1, host2!
 
                 .. seealso::
 
+                   :py:mod:`cylc.flow.main_loop.auto_restart`
                    :ref:`auto-stop-restart`
 
+                .. versionchanged:: 8.4.2
+
+                   The "force mode" (activated by a "!" suffix) caused issues
+                   at workflow startup for Cylc versions between 8.0.0 and
+                   8.4.1 inclusive.
+
                 .. versionchanged:: 8.0.0
 
                    {REPLACES}``[suite servers]condemned hosts``.
@@ -1336,7 +1372,7 @@ def default_for(
                 The means by which task progress messages are reported back to
                 the running workflow.
 
-                ..rubric:: Options:
+                .. rubric:: Options:
 
                 zmq
                    Direct client-server TCP communication via network ports