From f0b3b8585fd7039097eaa9c8be4a182e2f2ece7b Mon Sep 17 00:00:00 2001 From: Pierre Siddall <43399998+Pierre-siddall@users.noreply.github.com> Date: Thu, 20 Aug 2026 11:14:14 +0100 Subject: [PATCH 1/6] Add deprecated warnings to the legacy build and deploy sphinx workflows --- .github/workflows/build-sphinx-docs.yaml | 4 ++++ .github/workflows/deploy-sphinx-docs.yaml | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/.github/workflows/build-sphinx-docs.yaml b/.github/workflows/build-sphinx-docs.yaml index c50fcb8..76cf998 100644 --- a/.github/workflows/build-sphinx-docs.yaml +++ b/.github/workflows/build-sphinx-docs.yaml @@ -51,6 +51,10 @@ jobs: SPHINX_OPTS: ${{ inputs.sphinx-opts }} BUILD_DIR: ${{ inputs.build-directory }} steps: + - name: Deprecation warning + run: | + echo "::warning title=Deprecated workflow::This reusable workflow is deprecated and will be removed in the future. Please migrate to the sphinx-docs.yaml workflow." + - name: Checkout repository uses: actions/checkout@v6 diff --git a/.github/workflows/deploy-sphinx-docs.yaml b/.github/workflows/deploy-sphinx-docs.yaml index 0e8071e..955b1c2 100644 --- a/.github/workflows/deploy-sphinx-docs.yaml +++ b/.github/workflows/deploy-sphinx-docs.yaml @@ -29,6 +29,10 @@ jobs: pages: write id-token: write steps: + - name: Deprecation warning + run: | + echo "::warning title=Deprecated workflow::This reusable workflow is deprecated and will be removed in the future. Please migrate to the sphinx-docs.yaml workflow." + - name: Configure GitHub Pages id: configure uses: actions/configure-pages@v5 From 73fd91e956bd637f023be045b603a571c4f4a184 Mon Sep 17 00:00:00 2001 From: Pierre Siddall <43399998+Pierre-siddall@users.noreply.github.com> Date: Thu, 20 Aug 2026 13:11:29 +0100 Subject: [PATCH 2/6] Apply suggestion from @yaswant Co-authored-by: Yaswant Pradhan <2984440+yaswant@users.noreply.github.com> --- .github/workflows/build-sphinx-docs.yaml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/workflows/build-sphinx-docs.yaml b/.github/workflows/build-sphinx-docs.yaml index 26231d5..cc9f8de 100644 --- a/.github/workflows/build-sphinx-docs.yaml +++ b/.github/workflows/build-sphinx-docs.yaml @@ -60,7 +60,12 @@ jobs: steps: - name: Deprecation warning run: | - echo "::warning title=Deprecated workflow::This reusable workflow is deprecated and will be removed in the future. Please migrate to the sphinx-docs.yaml workflow." + echo "::warning title=Workflow Deprecated::This reusable workflow will be removed in future release. Please migrate to sphinx-docs.yaml workflow." + + echo "### ⚠️ Deprecation Notice" >> $GITHUB_STEP_SUMMARY +echo "The \`build-sphinx-docs\` reusable workflow has been **deprecated** and will be removed in the next release." >> $GITHUB_STEP_SUMMARY + echo "" >> $GITHUB_STEP_SUMMARY + echo "> **Migration Path:** Please transition your workflows to use the new unified action instead. Refer to the [sphinx-docs workflow guide](https://github.com/MetOffice/growss/tree/main/sphinx-docs) for details." >> $GITHUB_STEP_SUMMARY - name: Checkout repository uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 From 363f01771d717b5015f3fd3e9329fed4ea4017c8 Mon Sep 17 00:00:00 2001 From: Pierre Siddall <43399998+Pierre-siddall@users.noreply.github.com> Date: Thu, 20 Aug 2026 13:17:13 +0100 Subject: [PATCH 3/6] update deprecation warning --- .github/workflows/build-sphinx-docs.yaml | 2 +- .github/workflows/deploy-sphinx-docs.yaml | 7 ++++++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build-sphinx-docs.yaml b/.github/workflows/build-sphinx-docs.yaml index cc9f8de..f718815 100644 --- a/.github/workflows/build-sphinx-docs.yaml +++ b/.github/workflows/build-sphinx-docs.yaml @@ -63,7 +63,7 @@ jobs: echo "::warning title=Workflow Deprecated::This reusable workflow will be removed in future release. Please migrate to sphinx-docs.yaml workflow." echo "### ⚠️ Deprecation Notice" >> $GITHUB_STEP_SUMMARY -echo "The \`build-sphinx-docs\` reusable workflow has been **deprecated** and will be removed in the next release." >> $GITHUB_STEP_SUMMARY + echo "The \`build-sphinx-docs\` reusable workflow has been **deprecated** and will be removed in the next release." >> $GITHUB_STEP_SUMMARY echo "" >> $GITHUB_STEP_SUMMARY echo "> **Migration Path:** Please transition your workflows to use the new unified action instead. Refer to the [sphinx-docs workflow guide](https://github.com/MetOffice/growss/tree/main/sphinx-docs) for details." >> $GITHUB_STEP_SUMMARY diff --git a/.github/workflows/deploy-sphinx-docs.yaml b/.github/workflows/deploy-sphinx-docs.yaml index ce0b23a..9882e1c 100644 --- a/.github/workflows/deploy-sphinx-docs.yaml +++ b/.github/workflows/deploy-sphinx-docs.yaml @@ -36,7 +36,12 @@ jobs: steps: - name: Deprecation warning run: | - echo "::warning title=Deprecated workflow::This reusable workflow is deprecated and will be removed in the future. Please migrate to the sphinx-docs.yaml workflow." + echo "::warning title=Workflow Deprecated::This reusable workflow will be removed in future release. Please migrate to sphinx-docs.yaml workflow." + + echo "### ⚠️ Deprecation Notice" >> $GITHUB_STEP_SUMMARY + echo "The \`deploy-sphinx-docs\` reusable workflow has been **deprecated** and will be removed in the next release." >> $GITHUB_STEP_SUMMARY + echo "" >> $GITHUB_STEP_SUMMARY + echo "> **Migration Path:** Please transition your workflows to use the new unified action instead. Refer to the [sphinx-docs workflow guide](https://github.com/MetOffice/growss/tree/main/sphinx-docs) for details." >> $GITHUB_STEP_SUMMARY - name: Configure GitHub Pages id: configure From 37665a8a8d37c527692690b939f01f268a98e933 Mon Sep 17 00:00:00 2001 From: Pierre Siddall <43399998+Pierre-siddall@users.noreply.github.com> Date: Thu, 20 Aug 2026 13:21:21 +0100 Subject: [PATCH 4/6] add AI attribution for deprecation messages --- .github/workflows/build-sphinx-docs.yaml | 2 ++ .github/workflows/deploy-sphinx-docs.yaml | 2 ++ 2 files changed, 4 insertions(+) diff --git a/.github/workflows/build-sphinx-docs.yaml b/.github/workflows/build-sphinx-docs.yaml index f718815..234df62 100644 --- a/.github/workflows/build-sphinx-docs.yaml +++ b/.github/workflows/build-sphinx-docs.yaml @@ -3,6 +3,8 @@ # The file LICENCE, distributed with this code, contains details of the terms # under which the code may be used. # ------------------------------------------------------------------------------ +# Some of the content of this file has been produced with the assistance of +# Claude Opus 4.8." name: Build Sphinx Docs diff --git a/.github/workflows/deploy-sphinx-docs.yaml b/.github/workflows/deploy-sphinx-docs.yaml index 9882e1c..34af1c2 100644 --- a/.github/workflows/deploy-sphinx-docs.yaml +++ b/.github/workflows/deploy-sphinx-docs.yaml @@ -3,6 +3,8 @@ # The file LICENCE, distributed with this code, contains details of the terms # under which the code may be used. # ------------------------------------------------------------------------------ +# Some of the content of this file has been produced with the assistance of +# Claude Opus 4.8." name: Deploy Sphinx Docs From 597689fb1809698c010e0f03ebd8228e8090ca9d Mon Sep 17 00:00:00 2001 From: Pierre Siddall <43399998+Pierre-siddall@users.noreply.github.com> Date: Thu, 20 Aug 2026 13:24:05 +0100 Subject: [PATCH 5/6] remove typo --- .github/workflows/build-sphinx-docs.yaml | 2 +- .github/workflows/deploy-sphinx-docs.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build-sphinx-docs.yaml b/.github/workflows/build-sphinx-docs.yaml index 234df62..e5a670e 100644 --- a/.github/workflows/build-sphinx-docs.yaml +++ b/.github/workflows/build-sphinx-docs.yaml @@ -4,7 +4,7 @@ # under which the code may be used. # ------------------------------------------------------------------------------ # Some of the content of this file has been produced with the assistance of -# Claude Opus 4.8." +# Claude Opus 4.8. name: Build Sphinx Docs diff --git a/.github/workflows/deploy-sphinx-docs.yaml b/.github/workflows/deploy-sphinx-docs.yaml index 34af1c2..478009e 100644 --- a/.github/workflows/deploy-sphinx-docs.yaml +++ b/.github/workflows/deploy-sphinx-docs.yaml @@ -4,7 +4,7 @@ # under which the code may be used. # ------------------------------------------------------------------------------ # Some of the content of this file has been produced with the assistance of -# Claude Opus 4.8." +# Claude Opus 4.8. name: Deploy Sphinx Docs From 5e774d4d146334d8c4590dc1f4c64a87073cec23 Mon Sep 17 00:00:00 2001 From: Pierre Siddall <43399998+Pierre-siddall@users.noreply.github.com> Date: Thu, 20 Aug 2026 13:30:30 +0100 Subject: [PATCH 6/6] Keep deprication text consistent --- .github/workflows/build-sphinx-docs.yaml | 2 +- .github/workflows/deploy-sphinx-docs.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build-sphinx-docs.yaml b/.github/workflows/build-sphinx-docs.yaml index e5a670e..e604768 100644 --- a/.github/workflows/build-sphinx-docs.yaml +++ b/.github/workflows/build-sphinx-docs.yaml @@ -62,7 +62,7 @@ jobs: steps: - name: Deprecation warning run: | - echo "::warning title=Workflow Deprecated::This reusable workflow will be removed in future release. Please migrate to sphinx-docs.yaml workflow." + echo "::warning title=Workflow Deprecated::This reusable workflow will be removed in next release. Please migrate to sphinx-docs.yaml workflow." echo "### ⚠️ Deprecation Notice" >> $GITHUB_STEP_SUMMARY echo "The \`build-sphinx-docs\` reusable workflow has been **deprecated** and will be removed in the next release." >> $GITHUB_STEP_SUMMARY diff --git a/.github/workflows/deploy-sphinx-docs.yaml b/.github/workflows/deploy-sphinx-docs.yaml index 478009e..2acd3d9 100644 --- a/.github/workflows/deploy-sphinx-docs.yaml +++ b/.github/workflows/deploy-sphinx-docs.yaml @@ -38,7 +38,7 @@ jobs: steps: - name: Deprecation warning run: | - echo "::warning title=Workflow Deprecated::This reusable workflow will be removed in future release. Please migrate to sphinx-docs.yaml workflow." + echo "::warning title=Workflow Deprecated::This reusable workflow will be removed in the next release. Please migrate to sphinx-docs.yaml workflow." echo "### ⚠️ Deprecation Notice" >> $GITHUB_STEP_SUMMARY echo "The \`deploy-sphinx-docs\` reusable workflow has been **deprecated** and will be removed in the next release." >> $GITHUB_STEP_SUMMARY