From 7fc748763f6aaddf0692e82c5cb7c51c0824fa25 Mon Sep 17 00:00:00 2001 From: Lauren Chilutti Date: Wed, 25 Mar 2026 10:23:56 -0400 Subject: [PATCH 1/7] adding in an rst linter --- .github/workflows/rst_lint.yml | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 .github/workflows/rst_lint.yml diff --git a/.github/workflows/rst_lint.yml b/.github/workflows/rst_lint.yml new file mode 100644 index 000000000..8708a3450 --- /dev/null +++ b/.github/workflows/rst_lint.yml @@ -0,0 +1,32 @@ +name: reStructuredText Lint +on: + push: + branches: + - 'main' + pull_request: + +jobs: + run_lint: + runs-on: ubuntu-latest + steps: + - name: Code Checkout + uses: actions/checkout@v4 + - name: Make Sphinx Requirements + run: | + echo "sphinx" > requirements.txt + echo "sphinx_rtd_theme" >> requirements.txt + echo "sphinx_design" >> requirements.txt + echo "sphinx-sitemap" >> requirements.txt + echo "sphinxcontrib-mermaid" >> requirements.txt + echo "doc8" >> requirements.txt + - name: Prepare Python + uses: actions/setup-python@v5 + with: + python-version: '3.10' + cache: 'pip' + - name: Install Python Requirements + run: | + pip install -r requirements.txt + pip install doc8 + - name: Lint RST files + run: doc8 source From 692639d4981b3f9d0ff36af01f138f3e428d2469 Mon Sep 17 00:00:00 2001 From: Lauren Chilutti Date: Wed, 25 Mar 2026 10:28:33 -0400 Subject: [PATCH 2/7] modiy lint workflow - it had a copy paste error --- .github/workflows/rst_lint.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/rst_lint.yml b/.github/workflows/rst_lint.yml index 8708a3450..f1360680a 100644 --- a/.github/workflows/rst_lint.yml +++ b/.github/workflows/rst_lint.yml @@ -29,4 +29,4 @@ jobs: pip install -r requirements.txt pip install doc8 - name: Lint RST files - run: doc8 source + run: doc8 * From 834f8a7628f70a2203b1765a729c22a3886b470f Mon Sep 17 00:00:00 2001 From: Lauren Chilutti Date: Tue, 23 Jun 2026 15:02:15 -0400 Subject: [PATCH 3/7] updating pyproject yaml to build doc8 for rst linting as an optional docs dependency. Also updating rst linter workflow to install via pip without a requirements.txt. --- .github/workflows/rst_lint.yml | 23 ++++++++++++----------- pyproject.toml | 1 + 2 files changed, 13 insertions(+), 11 deletions(-) diff --git a/.github/workflows/rst_lint.yml b/.github/workflows/rst_lint.yml index f1360680a..cc91bd72a 100644 --- a/.github/workflows/rst_lint.yml +++ b/.github/workflows/rst_lint.yml @@ -11,22 +11,23 @@ jobs: steps: - name: Code Checkout uses: actions/checkout@v4 - - name: Make Sphinx Requirements - run: | - echo "sphinx" > requirements.txt - echo "sphinx_rtd_theme" >> requirements.txt - echo "sphinx_design" >> requirements.txt - echo "sphinx-sitemap" >> requirements.txt - echo "sphinxcontrib-mermaid" >> requirements.txt - echo "doc8" >> requirements.txt + with: + path: 'fre-cli' + - name: Checkout external catalogbuilder repo + uses: actions/checkout@v4 + with: + repository: 'NOAA-GFDL/CatalogBuilder' + path: 'CatalogBuilder' - name: Prepare Python uses: actions/setup-python@v5 with: python-version: '3.10' cache: 'pip' + - name: Install CatalogBuilder + run: pip install ./CatalogBuilder - name: Install Python Requirements - run: | - pip install -r requirements.txt - pip install doc8 + working-directory: ./fre-cli + run: pip install .[docs] - name: Lint RST files + working-directory: ./fre-cli run: doc8 * diff --git a/pyproject.toml b/pyproject.toml index b3f0f617c..30a4ac5a8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -59,6 +59,7 @@ docs = [ "sphinx", "renku-sphinx-theme", "sphinx-rtd-theme", + "doc8", ] test = [ From 92b584818aab3ca8f19414a9f4beb901eb6b4345 Mon Sep 17 00:00:00 2001 From: Lauren Chilutti Date: Tue, 23 Jun 2026 15:05:39 -0400 Subject: [PATCH 4/7] updating rst_lint CI to use python 3.11 to hopefully get pst a catalog builder build error --- .github/workflows/rst_lint.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/rst_lint.yml b/.github/workflows/rst_lint.yml index cc91bd72a..404aa5343 100644 --- a/.github/workflows/rst_lint.yml +++ b/.github/workflows/rst_lint.yml @@ -21,7 +21,7 @@ jobs: - name: Prepare Python uses: actions/setup-python@v5 with: - python-version: '3.10' + python-version: '3.11' cache: 'pip' - name: Install CatalogBuilder run: pip install ./CatalogBuilder From f9de1663f0ead73838f6facbe26df07bbf4e4ab8 Mon Sep 17 00:00:00 2001 From: Lauren Chilutti Date: Tue, 23 Jun 2026 15:07:31 -0400 Subject: [PATCH 5/7] reference 2026.01.01 version of catalogbuilder in rst_lint pip install --- .github/workflows/rst_lint.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/rst_lint.yml b/.github/workflows/rst_lint.yml index 404aa5343..c996eb5fb 100644 --- a/.github/workflows/rst_lint.yml +++ b/.github/workflows/rst_lint.yml @@ -17,6 +17,7 @@ jobs: uses: actions/checkout@v4 with: repository: 'NOAA-GFDL/CatalogBuilder' + ref: '2026.01.01' path: 'CatalogBuilder' - name: Prepare Python uses: actions/setup-python@v5 From 028efa83d322b550b4072fa17d1208acbd5c580c Mon Sep 17 00:00:00 2001 From: Lauren Chilutti <60401591+laurenchilutti@users.noreply.github.com> Date: Wed, 24 Jun 2026 09:29:27 -0400 Subject: [PATCH 6/7] Refactor RST lint workflow to avoid full docs build Removed external catalogbuilder checkout and installation steps. Added doc8 installation for RST linting. --- .github/workflows/rst_lint.yml | 13 +------------ 1 file changed, 1 insertion(+), 12 deletions(-) diff --git a/.github/workflows/rst_lint.yml b/.github/workflows/rst_lint.yml index c996eb5fb..293ba2531 100644 --- a/.github/workflows/rst_lint.yml +++ b/.github/workflows/rst_lint.yml @@ -11,24 +11,13 @@ jobs: steps: - name: Code Checkout uses: actions/checkout@v4 - with: - path: 'fre-cli' - - name: Checkout external catalogbuilder repo - uses: actions/checkout@v4 - with: - repository: 'NOAA-GFDL/CatalogBuilder' - ref: '2026.01.01' - path: 'CatalogBuilder' - name: Prepare Python uses: actions/setup-python@v5 with: python-version: '3.11' cache: 'pip' - - name: Install CatalogBuilder - run: pip install ./CatalogBuilder - name: Install Python Requirements working-directory: ./fre-cli - run: pip install .[docs] + run: pip install doc8 - name: Lint RST files - working-directory: ./fre-cli run: doc8 * From a2a6827587c7540b4ee2628c6217ef30f302bf04 Mon Sep 17 00:00:00 2001 From: Lauren Chilutti <60401591+laurenchilutti@users.noreply.github.com> Date: Wed, 24 Jun 2026 09:31:16 -0400 Subject: [PATCH 7/7] Update lint workflow to remove working-directory Removed working-directory for Python requirements installation. --- .github/workflows/rst_lint.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/rst_lint.yml b/.github/workflows/rst_lint.yml index 293ba2531..95922c653 100644 --- a/.github/workflows/rst_lint.yml +++ b/.github/workflows/rst_lint.yml @@ -17,7 +17,6 @@ jobs: python-version: '3.11' cache: 'pip' - name: Install Python Requirements - working-directory: ./fre-cli run: pip install doc8 - name: Lint RST files run: doc8 *