https://github.com/ffflabs/pm2-action

https://github.com/ffflabs/pm2-action

Last synced: 16 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/ffflabs/pm2-action
• Owner: ffflabs
• License: apache-2.0
• Created: 2020-12-11T13:30:53.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2022-11-10T09:51:28.000Z (about 2 years ago)
• Last Synced: 2024-11-17T08:03:49.571Z (about 1 month ago)
• Language: JavaScript
• Size: 862 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Newman Action

Allows you to run Postman's headless collction runner, Newman, via a GitHub Action meaning no config of the Newman lib itself.

## Getting Started

This action supports multiple ways of retrieving your Postman collections/environments.

### Local files

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

```

### Via URL

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

```

### Via Postman API

The latest version of your collection and/or environment is available through [Postman's API](https://docs.api.getpostman.com/?version=latest). 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](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables) 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

```

## Example workflow file

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

env:

  POSTMAN_APIKEY: ${{ secrets.postmanApiKey }}

  POSTMAN_COLLECTION: ${{ secrets.postmanCollection }}

  POSTMAN_ENVIRONMENT: ${{ secrets.postmanStagingEnvironment }}

  POSTMAN_ITERATION_DATA: ${{ secrets.POSTMAN_ITERATION_DATA_DEV }}

jobs:

  newman_requests_production:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v2

        with:

          fetch-depth: 2

      - uses: ffflabs/[email protected]

        with:

          postmanApiKey: ${{ env.POSTMAN_APIKEY }}

          collection: ${{ env.POSTMAN_COLLECTION }}

          environment: ${{ env.POSTMAN_ENVIRONMENT }}

          iterationData: ${{ env.POSTMAN_ITERATION_DATA }}

          reporters: cli

          reporter: '{"cli":{"noConsole":true}}'

```

(note the strngified parameter passed to `reporter`: it will save a lot of verbosity for collections that use `console.log` thoroughtly)

See [Workflow syntax for GitHub Actions](https://help.github.com/en/articles/workflow-syntax-for-github-actions) for more.

## Other settings

As well as `postmanApiKey`, `collection`, and `environment`, all other Newman settings are supported. You can find a full list [on the Newman docs](https://github.com/postmanlabs/newman#api-reference).