[Python-checkins] [3.11] Convert `doc.yml` workflow to be reusable (GH-103914 + GH-105151) (#107043)

ambv webhook-mailer at python.org
Sun Jul 23 05:35:00 EDT 2023


https://github.com/python/cpython/commit/561029aeb060941ea3dabece753928e6b4674653
commit: 561029aeb060941ea3dabece753928e6b4674653
branch: 3.11
author: Sviatoslav Sydorenko <wk.cvs.github at sydorenko.org.ua>
committer: ambv <lukasz at langa.pl>
date: 2023-07-23T11:34:56+02:00
summary:

[3.11] Convert `doc.yml` workflow to be reusable (GH-103914 + GH-105151) (#107043)

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github at sydorenko.org.ua>
Co-authored-by: Adam Turner <9087854+AA-Turner at users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk at users.noreply.github.com>.

(cherry picked from commit 88d14da76f579fe014cbd7c15e42be4234135fe9)
(cherry picked from commit eaa670228066220f08c8d73f80365c50058d40b8)

files:
A .github/workflows/reusable-docs.yml
D .github/workflows/doc.yml
M .github/workflows/build.yml

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 6848ed6f54bf0..5dc63ff64e9ca 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -26,7 +26,7 @@ permissions:
   contents: read
 
 concurrency:
-  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}-reusable
   cancel-in-progress: true
 
 jobs:
@@ -35,6 +35,7 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 10
     outputs:
+      run-docs: ${{ steps.docs-changes.outputs.run-docs || false }}
       run_tests: ${{ steps.check.outputs.run_tests }}
       run_ssl_tests: ${{ steps.check.outputs.run_ssl_tests }}
       config_hash: ${{ steps.config_hash.outputs.hash }}
@@ -68,6 +69,29 @@ jobs:
         id: config_hash
         run: |
           echo "hash=${{ hashFiles('configure', 'configure.ac', '.github/workflows/build.yml') }}" >> $GITHUB_OUTPUT
+      - name: Get a list of the changed documentation-related files
+        if: github.event_name == 'pull_request'
+        id: changed-docs-files
+        uses: Ana06/get-changed-files at v2.2.0
+        with:
+          filter: |
+            Doc/**
+            Misc/**
+            .github/workflows/reusable-docs.yml
+          format: csv  # works for paths with spaces
+      - name: Check for docs changes
+        if: >-
+          github.event_name == 'pull_request'
+          && steps.changed-docs-files.outputs.added_modified_renamed != ''
+        id: docs-changes
+        run: |
+          echo "run-docs=true" >> "${GITHUB_OUTPUT}"
+
+  check-docs:
+    name: Docs
+    needs: check_source
+    if: fromJSON(needs.check_source.outputs.run-docs)
+    uses: ./.github/workflows/reusable-docs.yml
 
   check_abi:
     name: 'Check if the ABI has changed'
diff --git a/.github/workflows/doc.yml b/.github/workflows/reusable-docs.yml
similarity index 89%
rename from .github/workflows/doc.yml
rename to .github/workflows/reusable-docs.yml
index e32078c67fba6..eade14bc8d619 100644
--- a/.github/workflows/doc.yml
+++ b/.github/workflows/reusable-docs.yml
@@ -1,29 +1,8 @@
 name: Docs
 
 on:
+  workflow_call:
   workflow_dispatch:
-  #push:
-  #  branches:
-  #  - 'main'
-  #  - '3.11'
-  #  - '3.10'
-  #  - '3.9'
-  #  - '3.8'
-  #  - '3.7'
-  #  paths:
-  #  - 'Doc/**'
-  pull_request:
-    branches:
-    - 'main'
-    - '3.11'
-    - '3.10'
-    - '3.9'
-    - '3.8'
-    - '3.7'
-    paths:
-    - 'Doc/**'
-    - 'Misc/**'
-    - '.github/workflows/doc.yml'
 
 permissions:
   contents: read



More information about the Python-checkins mailing list