Allows you to run Postman's headless collection runner, Newman, via a GitHub Action meaning no config of the Newman lib itself.
This action supports multiple ways of retrieving your Postman collections/environments.
If you've exported your collection and/or environment to your repo, provide the relative path to where the file sits in your repo (default: postman_collection.json
/ postman_environment.json
).
- uses: actions/checkout@master
- uses: matt-ball/newman-action@master
with:
collection: postman_collection.json
environment: postman_environment.json
If you're collection and/or environment is sitting at a URL accessible to your GitHub action, you can include that directly.
- uses: actions/checkout@master
- uses: matt-ball/newman-action@master
with:
collection: https://example.com/postman/collection.json
environment: https://example.com/postman/environment.json
The latest version of your collection and/or environment is available through Postman's API. The API docs contain endpoints that will allow you to retrieve the required IDs. Passing these IDs along with your Postman API key will run Newman in this method. See Creating and using secrets for how to add your Postman API to GitHub securely.
- uses: actions/checkout@master
- uses: matt-ball/newman-action@master
with:
postmanApiKey: ${{ secrets.postmanApiKey }}
collection: 5922408-c22ef764-b464-424c-8702-750343478723
environment: 5922408-228c7edd-fc15-4f68-9665-a35d7df6945b
This yml file should be located in .github/workflows
. You can mix and match any of the above methods.
name: Newman Run
on:
pull_request:
branches:
- master
jobs:
newman:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: matt-ball/newman-action@master
with:
apiKey: ${{ secrets.postmanApiKey }}
collection: postman_collection.json
environment: 5922408-228c7edd-fc15-4f68-9665-a35d7df6945b
See Workflow syntax for GitHub Actions for more.
As well as apiKey
, collection
, and environment
, all other Newman settings are supported. You can find a full list on the Newman docs. This action uses the Node module under the hood, so ensure you are reading the API reference rather than the command line options. Alternatively, you can see the available options in action.yml
in this repo.