examples.md

Workflow examples

Minimal setup

- uses: dvdstelt/hyperhawk@v1
  with:
    token: ${{ secrets.GITHUB_TOKEN }}

Skip external link checking (air-gapped / restricted runners)

- uses: dvdstelt/hyperhawk@v1
  with:
    token: ${{ secrets.GITHUB_TOKEN }}
    check-external: false

Scan only a specific folder

- uses: dvdstelt/hyperhawk@v1
  with:
    token: ${{ secrets.GITHUB_TOKEN }}
    files: 'docs/**/*.md'

Scan all files except one specific file

- uses: dvdstelt/hyperhawk@v1
  with:
    token: ${{ secrets.GITHUB_TOKEN }}
    files: '**/*.md,!process/dont-scan-this-one.md'

High-concurrency scan for large repos

- uses: dvdstelt/hyperhawk@v1
  with:
    token: ${{ secrets.GITHUB_TOKEN }}
    concurrency: 20
    timeout: 15000

Skip links inside code blocks

- uses: dvdstelt/hyperhawk@v1
  with:
    token: ${{ secrets.GITHUB_TOKEN }}
    skip-code-blocks: true

Only report issues on changed lines

- uses: dvdstelt/hyperhawk@v1
  with:
    token: ${{ secrets.GITHUB_TOKEN }}
    report-only-changed: true

Ignore specific domains and enable strict mode

- uses: dvdstelt/hyperhawk@v1
  with:
    token: ${{ secrets.GITHUB_TOKEN }}
    ignore-patterns: 'localhost,example\.com'
    strict: true

Cross-repo access with a GitHub App

See Cross-repo access for full setup instructions.

- uses: actions/create-github-app-token@v1
  id: app-token
  with:
    app-id: ${{ secrets.APP_ID }}
    private-key: ${{ secrets.APP_PRIVATE_KEY }}
    owner: ${{ github.repository_owner }}

- uses: dvdstelt/hyperhawk@v1
  with:
    token: ${{ secrets.GITHUB_TOKEN }}
    cross-repo-token: ${{ steps.app-token.outputs.token }}