Merge branch 'main' into optimise-build-docs

Author: cameronbateman-mo

.github/workflows/build-sphinx-docs.yaml

@@ -15,10 +15,10 @@ on:
         type: string
         default: '3.14'
       docs-directory:
-        description: 'Directory containing the documentation to build'
+        description: 'Directory containing the documentation source to build'
         required: false
         type: string
-        default: './documentation'
+        default: 'documentation'
       requirements:
         description: 'Path to the requirements file to install dependencies from'
         required: true
@@ -33,7 +33,7 @@ on:
         description: 'Directory to output the html documentation to'
         required: false
         type: string
-        default: '${{inputs.docs-directory}}/build'
+        default: 'build'
       runner:
         description: 'The runner to use for the job'
         required: false
@@ -49,7 +49,7 @@ jobs:
   build-sphinx-docs:
     name: Build Sphinx Docs
     runs-on: ${{ inputs.runner }}
-
+    timeout-minutes: ${{ inputs.timeout }}
     env:
       DOCS_DIR: ${{ inputs.docs-directory }}
       REQS_FILE: ${{ inputs.requirements }}
@@ -79,6 +79,9 @@ jobs:
       - name: Install dependencies
         run: uv pip install -r "$REQS_FILE"
 
+      - name: Minimize pip cache
+        run: python3 -m pip cache remove '*' || true
+
       - name: Lint Sphinx docs
         working-directory: ${{ env.DOCS_DIR }}
         run: sphinx-lint .
@@ -88,7 +91,6 @@ jobs:
         run: |
           make html SPHINXOPTS="$SPHINX_OPTS" BUILDDIR="$BUILD_DIR"
 
-
       - name: Upload artifact to GitHub Pages
         if: ${{ (github.event_name == 'push' || github.event_name == 'merge_group') && github.ref_name == 'main'}}
         uses: actions/upload-pages-artifact@v4

.github/workflows/fortran-lint.yaml

@@ -0,0 +1,67 @@
+# ------------------------------------------------------------------------------
+#  (c) Crown copyright Met Office. All rights reserved.
+#  The file LICENCE, distributed with this code, contains details of the terms
+#  under which the code may be used.
+# ------------------------------------------------------------------------------
+
+name: Fortran lint
+on:
+  workflow_call:
+
+    inputs:
+      runner:
+        description: 'The runner to use for the job'
+        required: false
+        type: string
+        default: 'ubuntu-latest'
+      timeout:
+        description: 'The maximum time in minutes the job can run for'
+        required: false
+        type: number
+        default: 10
+      python-version:
+        description: 'The Python version to use'
+        required: false
+        type: string
+        default: '3.14'
+
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+
+jobs:
+  fortitude-linting:
+    name: Fortran lint
+    runs-on: ${{ inputs.runner }}
+    timeout-minutes: ${{ inputs.timeout }}
+
+    env:
+      UV_CACHE_DIR: /tmp/.uv_cache
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          python-version: ${{ inputs.python-version }}
+          enable-cache: true
+
+      - name: restore uv cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.UV_CACHE_DIR }}
+          key: ${{ runner.os }}-${{ hashFiles('uv.lock') }}-fortitude-0.7.3
+          restore-keys: |
+            uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+            uv-${{ runner.os }}
+
+      - name: Install Fortitude Linter
+        run: uv pip install fortitude-lint==0.7.3
+
+      - name: Run Fortitude Linter
+        run: fortitude check --respect-gitignore --show-fixes --file-extensions=f90,F90,x90,X90 .
+
+      - name: minimize uv cache
+        run: uv cache prune --ci

README.md

@@ -1,5 +1,7 @@
 # GRoWSS - GitHub Reusable Workflows for Simulation Systems :recycle:
 
+[![CI](https://github.com/MetOffice/growss/actions/workflows/validate.yaml/badge.svg?branch=main)](https://github.com/MetOffice/growss/actions/workflows/validate.yaml)
+
 Placeholder for a collection of
 [reusable workflows](https://docs.github.com/en/actions/learn-github-actions/reusing-workflows)
 for the Met Office Simulation Systems Repositories.

fortran-lint/README.md

@@ -0,0 +1,46 @@
+# Fortran Linting workflow (using Fortitude)
+
+This reusable workflow serves as a a generic workflow to lint fortran
+code using the fortitude linter.
+
+## Usage
+
+By default this workflow will check all the rules included in fortitude linter.
+However, should you wish to check only a certain set of rules in your local repository
+you can do this by implementing a `fortitude.toml` file in the top-level/root directory
+of your local repository, defining the rules which should be checked when running this
+reusable workflow from a caller workflow. The following toml file is an example of
+what your `fortitude.toml` file could look like:
+
+### Example fortitude configuration
+
+```toml
+[check]
+select = ["S", "T"]
+ignore = ["S001", "S051"]
+line-length = 132
+```
+
+In order to use this reusable workflow you should implement a calling workflow as
+a YAML file in your `.github/workflows` directory containing the follwing:
+
+### Example usage in caller workflow
+
+```yaml
+steps:
+  - name: Lint Fortran
+    uses: MetOffice/growss/.github/workflows/fortan-lint.yaml@main
+
+    with:
+       runner: The runner to use for the job (ubuntu-latest)
+       timeout: The maximum time in minutes the job can run for (10)
+       python-version: The Python version to use (3.14)
+```
+
+Where runner,timeout and python-version are all appropriately defined inputs
+to the workflow as defined in `MetOffice/growss/.github/workflows/fortan-lint.yaml`
+
+### Further details
+Fortitude is a fortran linter developed and maintained by PlasmaFAIR. For further details on
+how to configure your `fortitude.toml` file and how to interpret error messages given by this
+reusable workflow please refer to the [fortitude doumentation](https://fortitude.readthedocs.io/en/latest/)