Merge branch 'master' into 8.0.x-deconflict

Author: MetRonnie

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

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

src/user-guide/writing-workflows/configuration.rst

@@ -149,3 +149,49 @@ show an inlined copy of the workflow with correct line numbers.
 
 .. automodule:: cylc.flow.scripts.lint
 
+Configure ``cylc lint`` at project level
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+You can configure ``cylc lint`` for each workflow using a
+``pyproject.toml`` file.
+
+To define settings for ``cylc lint`` use a ``[cylc-lint]`` section.
+Within the ``[cylc-lint]`` section you may define the following:
+
+rulesets
+   A list of rulesets to use. If you run cylc lint without setting rulesets
+   on the command line this value will override
+   the default (``['728', 'style']``).
+
+   Allowed Values: '728', 'style'
+
+ignore
+   Individual rules to ignore: A list of rule codes, such as ``S007``.
+
+exclude
+   A list of files or glob patterns for files which will not be checked.
+
+max-line-length
+   Set longest line length to permit in Cylc Configs for this project.
+   If unset, line length is not checked.
+
+
+An example ``pyproject.toml`` might look like this:
+
+.. code-block:: toml
+
+   [cylc-lint]
+   # Enforce a line limit of 99 chars
+   max-line-length = 99
+
+   # Ignore style [S] rule 007 (It's good practice comment with a reason)
+   ignore = ['S007']   # Family names start with lowercase in this workflow
+
+   # Don't check files matching these globs
+   exclude = ['history/*.old.cylc', 'someother.cylc']
+
+   # By default check for style
+   rulesets = ['style']
+
+   [some-other-section]
+   # Cylc lint won't pay any attention to this.