GitHub Actions

Run Nimbus tasks automatically in CI using the arpjw/nimbus-action GitHub Action.

Quick start

# .github/workflows/nimbus.yml
name: Nimbus Review
on: [pull_request]

jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - uses: arpjw/nimbus-action@v1
        with:
          task: review
          api_key: ${{ secrets.NIMBUS_API_KEY }}

Add NIMBUS_API_KEY to your repo's Settings → Secrets.

Available tasks

Task	Description
review	Review the PR diff, post structured comment
test-coverage	Run test-coverage agent, open PR with new tests
security	Run security-audit agent on changed files
docs	Run api-documenter on changed API routes
<any text>	Run as a freeform Nimbus task

Inputs

Input	Required	Default	Description
task	yes	review	Task type or description
api_key	yes	—	From get-nimbus.com/dashboard
repo	no	current repo	owner/name override
fail_on_issues	no	false	Exit 1 if issues found
severity	no	high	Minimum severity to fail on

Outputs

Output	Description
pr_url	PR URL if opened
status	success | failed | timeout

Weekly maintenance pipeline

name: Weekly Nimbus Maintenance
on:
  schedule:
    - cron: '0 9 * * 1'  # Every Monday at 9am

jobs:
  maintain:
    runs-on: ubuntu-latest
    steps:
      - uses: arpjw/nimbus-action@v1
        with:
          task: security
          api_key: ${{ secrets.NIMBUS_API_KEY }}

      - uses: arpjw/nimbus-action@v1
        with:
          task: test-coverage
          api_key: ${{ secrets.NIMBUS_API_KEY }}