Merge branch 'master' into 8.0.x-sync

Author: oliver-sanders

.github/workflows/deploy.yml

@@ -69,17 +69,21 @@ jobs:
         with:
           python-version: '3.9'
 
+      - name: configure git
+        uses: cylc/release-actions/configure-git@v1
+
       - name: checkout cylc-doc
         uses: actions/checkout@v3
         with:
-          ref: ${{ github.event.inputs.cylc-flow-tag }}
+          ref: ${{ inputs.cylc-flow-tag }}
           path: docs
 
       - name: install dependencies
         uses: cylc/cylc-doc/.github/actions/install-dependencies@master
 
       - name: install cylc-doc
-        run: pip install "${{ github.workspace }}/docs[all]"
+        working-directory: docs
+        run: pip install ".[all]"
 
       - name: install libs to document
         uses: cylc/cylc-doc/.github/actions/install-libs@master
@@ -98,21 +102,18 @@ jobs:
           path: gh-pages
 
       - name: sync static files
-        if: ${{ github.event.inputs.set_stable == 'true' }}
+        if: ${{ inputs.set_stable }}
+        env:
+          DOCS: '${{ github.workspace }}/docs'
+          PAGE: '${{ github.workspace }}/gh-pages'
         run: |
-          DOCS="${{ github.workspace }}/docs" \
-          PAGE="${{ github.workspace }}/gh-pages"  \
-
           rsync -r "$DOCS/doc/" "$PAGE/"
 
       - name: install gh-pages
+        working-directory: docs
         run: |
-          DOCS="${{ github.workspace }}/docs" \
-          PAGE="${{ github.workspace }}/gh-pages"  \
-
-          cd "$DOCS"
           rm -r doc
-          ln -s "$PAGE" doc
+          ln -s ../gh-pages doc
 
       - name: build docs
         run: |
@@ -125,20 +126,17 @@ jobs:
             linkcheck \
             SPHINXOPTS='-Wn --keep-going' \
             FORCE_COLOR=true \
-            STABLE=${{ github.event.inputs.set_stable }} \
-            LATEST=${{ github.event.inputs.set_latest }}
-
-      - name: configure git
-        uses: cylc/release-actions/configure-git@v1
+            STABLE=${{ inputs.set_stable }} \
+            LATEST=${{ inputs.set_latest }}
 
       - name: tidy old versions
+        working-directory: docs
         run: |
-          cd docs
-          git rm -r $("${{ github.workspace }}/docs/bin/version" tidy) || true
+          git rm -r $("./bin/version" tidy) || true
 
       - name: push changes
+        working-directory: gh-pages
         run: |
-          cd gh-pages
           git add *
-          git commit -m "add: ${{ github.event.inputs.cylc-flow-tag }}"
+          git commit -m "add: ${{ inputs.cylc-flow-tag }}"
           git push origin HEAD

.github/workflows/shortlog.yml

@@ -9,7 +9,7 @@ on:
       - '.github/workflows/shortlog.yml'
 
 jobs:
-  test:
+  shortlog:
     runs-on: 'ubuntu-latest'
     timeout-minutes: 10
     steps:

.github/workflows/undeploy.yml

@@ -36,15 +36,20 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 10
     env:
-      TAG: ${{ github.event.inputs.tag }}
+      TAG: ${{ inputs.tag }}
     steps:
       - name: configure python
         uses: actions/setup-python@v4
         with:
           python-version: '3.9'
 
+      - name: configure git
+        uses: cylc/release-actions/configure-git@v1
+
       - name: checkout cylc-doc
         uses: actions/checkout@v3
+        with:
+          path: docs
 
       - name: checkout gh-pages
         uses: actions/checkout@v3
@@ -67,17 +72,21 @@ jobs:
             fi
           done
 
-      - name: configure git
-        uses: cylc/release-actions/configure-git@v1
+      - name: install gh-pages
+        working-directory: docs
+        run: |
+          rm -r doc
+          ln -s ../gh-pages doc
 
       - name: remove version
         working-directory: gh-pages
         run: |
           git rm -r "$TAG"
 
       - name: update version file
+        working-directory: docs
         run: |
-          bin/version write
+          bin/version write > doc/versions.json
 
       - name: push changes
         working-directory: gh-pages

src/7-to-8/cheat-sheet.rst

@@ -59,6 +59,10 @@ Install a workflow from source and run it:
          # run the installed workflow
          cylc play <name>
 
+         # alternatively:
+         # validate, install & play
+         cylc vip <name>
+
 
 Reloading
 ---------
@@ -79,7 +83,7 @@ To update a running workflow with changes from the source directory:
      - ::
 
          # re-install from source
-         # and do ``cylc reload`` 
+         # and do ``cylc reload``
          rose suite-run --reload
      - ::
 

src/7-to-8/major-changes/cli.rst

@@ -113,6 +113,13 @@ GUI. Consequently the following commands have also been removed:
 The ``cylc gui`` command remains, it launches a standalone version of the
 web GUI (providing the `Cylc UI Server`_ is installed).
 
+.. seealso::
+
+   :ref:`CompoundCommands` - For your convenience we have
+    provided commands which represent common working practices. For
+    example ``cylc vip`` (Validate-Install-Play) which runs
+    ``cylc validate``, ``cylc install`` and ``cylc play``.
+
 
 Cylc 8 Standardised IDs
 -----------------------

src/dictionaries/proper_nouns

@@ -30,12 +30,14 @@ Posix
 Protobuf
 Pympler
 Pyro
+pyproject
 rsync
 sge
 slurm
 Slurm
 sqlite
 svn
+toml
 Trac
 Tui
 Vuex

src/dictionaries/words

@@ -133,6 +133,8 @@ retrigger
 retriggered
 retriggering
 roadmap
+ruleset
+rulesets
 runahead
 runnable
 runtime

src/hyperlinks.rst.include

@@ -58,7 +58,7 @@
    :height: 18px
    :align: middle
 
-.. |task-running| image:: /img/task-job-icons/task-running.png
+.. |task-running| image:: /img/task-job-icons/task-running-25.png
    :height: 18px
    :align: middle
 
@@ -71,6 +71,19 @@
    :align: middle
 
 
+.. |task-held| image:: /img/task-job-icons/task-isHeld.png
+   :height: 18px
+   :align: middle
+
+.. |task-runahead| image:: /img/task-job-icons/task-isRunahead.png
+   :height: 18px
+   :align: middle
+
+.. |task-queued| image:: /img/task-job-icons/task-isQueued.png
+   :height: 18px
+   :align: middle
+
+
 .. |job-submitted| image:: /img/task-job-icons/job-submitted.png
    :height: 18px
    :align: middle