feat!: run CLI 5 and fail the job on failing tests by default (v2)

.github/workflows/local.yml

@@ -38,12 +38,12 @@ on:
         description: issue_body
         required: false
         default: 'A Doc Detective run ($RUN_URL) failed with the following results:$RESULTS'
-      integrations:
-        description: integrations
+      issue_mentions:
+        description: issue_mentions
         required: false
         default: ''
-      prompt:
-        description: prompt
+      issue_prompt:
+        description: issue_prompt
         required: false
 
 permissions:
@@ -66,5 +66,5 @@ jobs:
         id: dd
         with:
           config: ./artifacts/.doc-detective.json
-          integrations: ${{ github.event.inputs.integrations }}
-          prompt: ${{ github.event.inputs.prompt }}
+          issue_mentions: ${{ github.event.inputs.issue_mentions }}
+          issue_prompt: ${{ github.event.inputs.issue_prompt }}

.github/workflows/main.yml

@@ -10,7 +10,7 @@ on:
       version:
         description: version
         required: false
-        default: latest
+        default: '5'
       working_directory:
         description: working_directory
         required: false
@@ -42,12 +42,12 @@ on:
         description: issue_body
         required: false
         default: 'A Doc Detective run ($RUN_URL) failed with the following results:$RESULTS'
-      integrations:
-        description: integrations
+      issue_mentions:
+        description: issue_mentions
         required: false
         default: ''
-      prompt:
-        description: prompt
+      issue_prompt:
+        description: issue_prompt
         required: false
 
 permissions:
@@ -78,5 +78,5 @@ jobs:
           exit_on_fail: ${{ github.event.inputs.exit_on_fail }}
           create_issue_on_fail: ${{ github.event.inputs.create_issue_on_fail }}
           issue_body: ${{ github.event.inputs.issue_body }}
-          integrations: ${{ github.event.inputs.integrations }}
-          prompt: ${{ github.event.inputs.prompt }}
+          issue_mentions: ${{ github.event.inputs.issue_mentions }}
+          issue_prompt: ${{ github.event.inputs.issue_prompt }}

.github/workflows/test-current-release.yml

@@ -10,7 +10,7 @@ on:
       version:
         description: version
         required: false
-        default: latest
+        default: '5'
       config:
         description: config
         required: false

.github/workflows/test.yml

@@ -21,6 +21,7 @@ jobs:
         uses: ./ # Uses an action in the root directory
         id: dd
         with:
+          version: v5-rc # Until 5.0.0 is on npm; `doc-detective@5` matches no prerelease. Drop at GA.
           config: ./artifacts/.doc-detective.json
           input: ./artifacts/doc-content-inline-tests.md
 
@@ -41,14 +42,22 @@ jobs:
         id: dd
         continue-on-error: true
         with:
+          version: v5-rc # Until 5.0.0 is on npm; `doc-detective@5` matches no prerelease. Drop at GA.
           config: ./artifacts/.doc-detective.json
           input: ./artifacts/doc-content-inline-tests-fail.md
           exit_on_fail: true
 
-  fail-tests-with-integrations:
+      - name: Assert the failing fixture fails the action on a failed spec
+        # A failed spec, not exit 2 (nothing tested) or a crash with no results.
+        if: steps.dd.outcome != 'failure' || !steps.dd.outputs.results || fromJSON(steps.dd.outputs.results).summary.specs.fail < 1
+        run: |
+          echo "Expected the Doc Detective step to fail because a spec in the failing fixture failed."
+          exit 1
+
+  fail-tests-with-issue-mentions:
     if: github.event_name == 'workflow_dispatch'
     runs-on: ubuntu-latest
-    name: Fail tests with integrations
+    name: Fail tests with issue mentions
     permissions:
       contents: read
       issues: write
@@ -59,9 +68,10 @@ jobs:
         id: dd
         continue-on-error: true
         with:
+          version: v5-rc # Until 5.0.0 is on npm; `doc-detective@5` matches no prerelease. Drop at GA.
           config: ./artifacts/.doc-detective.json
           input: ./artifacts/doc-content-inline-tests-fail.md
           exit_on_fail: true
           create_issue_on_fail: true
-          integrations: doc-sentinel,claude
-          prompt: "Investigate the failures and suggest fixes"
+          issue_mentions: doc-sentinel,claude
+          issue_prompt: "Investigate the failures and suggest fixes"