Fix comment and manual dispatch triggered build jobs

.circleci/config.yml

@@ -6,21 +6,34 @@
 # Check for more details: https://circleci.com/docs/2.1/configuration-reference
 version: 2.1
 
+# these are required by https://github.com/CircleCI-Public/trigger-circleci-pipeline-action
+parameters:
+  GHA_Actor:
+    type: string
+    default: ""
+  GHA_Action:
+    type: string
+    default: ""
+  GHA_Event:
+    type: string
+    default: ""
+  GHA_Meta:
+    type: string
+    default: ""
+
 # Orbs are reusable packages of CircleCI configuration that you may share across projects.
 # See: https://circleci.com/docs/2.1/orb-intro/
 orbs:
   python: circleci/[email protected]
 
-# parameterize the make target used for build, passed in from build_trigger.yml action
-parameters:
-  make_target:
-    type: string
-    default: "slimfast"
-
 jobs:
   build-docs:
     docker:
       - image: cimg/python:3.10.17
+    parameters: # job level setting of make target
+      make_target:
+        type: string
+        default: slimfast
     steps:
       - checkout:
           path: docs
@@ -47,7 +60,7 @@ jobs:
           command: |
             . .venv/bin/activate
             cd docs
-            xvfb-run --auto-servernum make << pipeline.parameters.make_target >>
+            xvfb-run --auto-servernum make << parameters.make_target >>
           environment:
             PIP_CONSTRAINT: ../napari/resources/constraints/constraints_py3.10_docs.txt
       - store_artifacts:
@@ -57,6 +70,21 @@ jobs:
           paths:
             - docs/docs/_build/html/
 workflows:
+  # default trigger on push, don't double up with actions
   build-docs:
+    when:
+      not: << pipeline.parameters.GHA_Meta >>
     jobs:
       - build-docs
+  # triggered by comment to PR with make target
+  triggered-by-issue-comment:
+    when:
+      or:
+        - equal: ["slimfast", << pipeline.parameters.GHA_Meta >>]
+        - equal: ["slimgallery", << pipeline.parameters.GHA_Meta >>]
+        - equal: ["docs", << pipeline.parameters.GHA_Meta >>]
+        - equal: ["html", << pipeline.parameters.GHA_Meta >>]
+        - equal: ["html-noplot", << pipeline.parameters.GHA_Meta >>]
+    jobs:
+      - build-docs:
+          make_target: << pipeline.parameters.GHA_Meta >>

.github/workflows/build_docs.yml

@@ -5,19 +5,23 @@ name: Build PR Docs
 on:
   pull_request:
     branches:
-        - main
+      - main
   workflow_dispatch:
     inputs:
       make_target:
         description: "Enter make target: html html-noplot docs slimfast slimgallery"
         type: string
-        default: 'slimfast'
+        default: "slimfast"
   workflow_call:
     inputs:
       make_target:
         description: "Enter make target: html html-noplot docs slimfast slimgallery"
         type: string
-        default: 'slimfast'
+        default: "slimfast"
+      pr_ref:
+        description: "PR branch reference"
+        type: string
+        required: false
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -33,6 +37,7 @@ jobs:
         with:
           # Check out to  '/home/runner/work/docs/docs/docs'
           path: docs
+          ref: ${{ inputs.pr_ref || github.ref }}
 
       - name: Clone main repo
         uses: actions/checkout@v4
@@ -70,7 +75,7 @@ jobs:
           GOOGLE_CALENDAR_API_KEY: ${{ secrets.GOOGLE_CALENDAR_API_KEY }}
           PIP_CONSTRAINT: ${{ github.workspace }}/napari/resources/constraints/constraints_py3.10_docs.txt
         with:
-          run:  make -C docs ${{ github.event_name == 'pull_request' && 'slimfast' || inputs.make_target }}
+          run: make -C docs ${{ inputs.make_target || 'slimfast' }}
           # skipping setup stops the action from running the default (tiling) window manager
           # the window manager is not necessary for docs builds at this time and it was causing
           # problems with screenshots (https://github.com/napari/docs/issues/285)

.github/workflows/triggered_target_build.yml

@@ -0,0 +1,119 @@
+name: Trigger target build of docs
+# this workflow is triggered by a comment on a PR or manually via workflow_dispatch
+# It allows you to specify a make target for building the docs for a branch/PR
+# When triggered by a comment, it will run on the PR branch and report status on the PR
+# # This is a one-time-run, it does not run on every push to the PR branch
+
+on:
+  issue_comment:
+    types: [created]
+  workflow_dispatch:
+    inputs:
+      make_target:
+        description: "Enter make target: html html-noplot docs slimfast slimgallery"
+        type: string
+        default: "slimfast"
+
+permissions:
+  contents: read
+  issues: write
+  pull-requests: write
+  statuses: write
+
+jobs:
+  determine-make-target:
+    runs-on: ubuntu-latest
+    outputs:
+      target: ${{ steps.determine-make-target.outputs.target }}
+      pr_ref: ${{ steps.get-pr-info.outputs.pr_ref }}
+      pr_sha: ${{ steps.get-pr-info.outputs.pr_sha }}
+    if: |
+      (github.event_name == 'issue_comment' &&
+        github.event.issue.pull_request != '' &&
+        contains(github.event.comment.body, '@napari-bot make')) ||
+      github.event_name == 'workflow_dispatch'
+    steps:
+      - name: Add eyes reaction
+        # If triggered by comment, show that workflow has started
+        if: github.event_name == 'issue_comment'
+        uses: actions/github-script@v7
+        with:
+          script: |
+            await github.rest.reactions.createForIssueComment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              comment_id: context.payload.comment.id,
+              content: 'eyes'
+            });
+
+      - name: Determine make target from comment or input
+        id: determine-make-target
+        env:
+          COMMENT_BODY: ${{ github.event.comment.body }}
+        run: |
+          ALLOWED_TARGETS="html html-noplot docs slimfast slimgallery"
+
+          if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
+            TARGET="${{ github.event.inputs.make_target }}"
+          else
+            TARGET=$(echo "$COMMENT_BODY" | grep -oP '(?<=@napari-bot make\s)\w+' || echo "slimfast")
+          fi
+
+          if ! echo "$ALLOWED_TARGETS" | grep -qw "$TARGET"; then
+            echo "::error::Invalid target '$TARGET'. Allowed: $ALLOWED_TARGETS"
+            exit 1
+          fi
+
+          echo "target=$TARGET" >> "$GITHUB_OUTPUT"
+
+      - name: Get PR details
+        # issue_comment is run from the main branch context so
+        # extract PR number and branch name from issue_comment event
+        if: github.event_name == 'issue_comment'
+        id: get-pr-info
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const pr = await github.rest.pulls.get({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              pull_number: context.issue.number
+            });
+            core.setOutput('pr_ref', pr.data.head.ref);
+            core.setOutput('pr_sha', pr.data.head.sha);
+
+  trigger-circleci:
+    needs: determine-make-target
+    runs-on: ubuntu-latest
+    steps:
+      - name: Run CircleCI pipeline
+        uses: CircleCI-Public/[email protected]
+        with:
+          GHA_Meta: ${{ needs.determine-make-target.outputs.target }}
+          target-branch: ${{ needs.determine-make-target.outputs.pr_ref || github.ref_name }}
+        env:
+          CCI_TOKEN: ${{ secrets.CIRCLECI_TOKEN }}
+
+  trigger-artifact-build:
+    needs: determine-make-target
+    uses: ./.github/workflows/build_docs.yml
+    with:
+      make_target: ${{ needs.determine-make-target.outputs.target }}
+      pr_ref: ${{ needs.determine-make-target.outputs.pr_ref || github.ref_name }}
+
+  report-artifact-status:
+    # reusable workflows can't be a step in a job
+    # so to get the status of the artifact build, we need a separate job
+    needs: [determine-make-target, trigger-artifact-build]
+    runs-on: ubuntu-latest
+    if: always() && github.event_name == 'issue_comment' && needs.trigger-artifact-build.result != 'skipped'
+    steps:
+      - name: Set build job status
+        uses: myrotvorets/set-commit-status-action@master
+        with:
+          sha: ${{ needs.determine-make-target.outputs.pr_sha }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          status: ${{ needs.trigger-artifact-build.result }}
+          context: "Docs Artifact Build: ${{ needs.determine-make-target.outputs.target }}"
+          description: ${{ needs.trigger-artifact-build.result == 'success' && 'Documentation built successfully' || 'Documentation build failed' }}
+          targetUrl: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}