docs: Add integrations and prompt inputs to README
#37
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| on: | |
| # push: # TODO: Uncomment this line to enable push events | |
| # branches: | |
| # - main | |
| pull_request: | |
| types: [opened, reopened, synchronize] | |
| workflow_dispatch: | |
| jobs: | |
| pass-tests: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, windows-latest, macos-latest] | |
| name: Pass tests | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Run Doc Detective | |
| uses: ./ # Uses an action in the root directory | |
| id: dd | |
| with: | |
| config: ./artifacts/.doc-detective.json | |
| input: ./artifacts/doc-content-inline-tests.md | |
| fail-tests: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, windows-latest, macos-latest] | |
| name: Fail tests | |
| permissions: | |
| contents: read | |
| issues: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Run Doc Detective | |
| uses: ./ # Uses an action in the root directory | |
| id: dd | |
| continue-on-error: true | |
| with: | |
| config: ./artifacts/.doc-detective.json | |
| input: ./artifacts/doc-content-inline-tests-fail.md | |
| exit_on_fail: true | |
| fail-tests-with-integrations: | |
| if: github.event_name == 'workflow_dispatch' | |
| runs-on: ubuntu-latest | |
| name: Fail tests with integrations | |
| permissions: | |
| contents: read | |
| issues: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Run Doc Detective | |
| uses: ./ | |
| id: dd | |
| continue-on-error: true | |
| with: | |
| 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" |