Skip to content

Running Collections

Basic Usage

Run all requests in a collection:

- uses: scarowar/insomnia-run@v0.1.0
  with:
    command: collection
    working-directory: .insomnia

With Environment

Target a specific Insomnia environment:

- uses: scarowar/insomnia-run@v0.1.0
  with:
    command: collection
    working-directory: .insomnia
    environment: staging

Filter Requests

By pattern:

- uses: scarowar/insomnia-run@v0.1.0
  with:
    command: collection
    working-directory: .insomnia
    request-name-pattern: ".*users.*"

By ID:

- uses: scarowar/insomnia-run@v0.1.0
  with:
    command: collection
    working-directory: .insomnia
    item: "req_001,req_002"

Iterations

Run the collection multiple times with data from a CSV or JSON file:

- uses: scarowar/insomnia-run@v0.1.0
  with:
    command: collection
    working-directory: .insomnia
    iteration-count: "5"
    iteration-data: "test-data.csv"

Timing

Control request delays and timeouts:

- uses: scarowar/insomnia-run@v0.1.0
  with:
    command: collection
    working-directory: .insomnia
    delay-request: "500"
    request-timeout: "30000"
    execution-timeout: "600"
  • request-timeout: Timeout for each individual request (milliseconds)
  • delay-request: Delay between requests (milliseconds)
  • execution-timeout: Max time for entire test run (seconds, default: 300)

Stop on Failure

Stop execution immediately when a request fails:

- uses: scarowar/insomnia-run@v0.1.0
  with:
    command: collection
    working-directory: .insomnia
    bail: "true"

With Secrets

Pass secrets via environment variables:

- uses: scarowar/insomnia-run@v0.1.0
  with:
    command: collection
    working-directory: .insomnia
  env:
    API_KEY: ${{ secrets.API_KEY }}

Access in Insomnia templates as {{ _.API_KEY }}.

See Handling Secrets for more options.