Configuring the Postman CLI for GitHub Actions After the build is complete, use the arrows to expand a build and expand an API definition to view any rule violations.

To view the results of API Governance and API Security checks that ran as part of the build, first configure the Postman CLI for GitHub Actions and then start a new build on GitHub. Using the Postman CLI, you can enforce Postman API Governance and API Security rules each time the pipeline runs using the api lint command ( Enterprise teams only). Viewing API Governance and API Security rule violations Learn more about using the Collection Runner. Select View Report to view a collection run report in the Postman History. After the build is complete, use the arrows to expand a build and expand a collection to view details about a collection run. To learn more about starting builds, see the GitHub Actions documentation. To view details for collections that were run as part of a build, first configure the Postman CLI for GitHub and then start a new build in GitHub. Using the Postman CLI, you can run Postman collections with your API tests as part of a GitHub Actions pipeline.

To edit or delete the integration, select the more actions icon.

To get the latest build status information, select Refresh.

To open a build in GitHub, select the build name.

Use the dropdown lists to filter jobs by branch or build status.

From here you can take the following actions: Select View All Builds to view the full list of build jobs.

You can't start GitHub Actions builds directly in Postman. The most recent jobs are listed under the repository name. To view build jobs, open an API and select Test and Automation. You can also view the results of collection runs that are configured in your pipeline using the Postman CLI. For each build you can view the branch, start time, and status ( Success or Failure). Select the GitHub Organization with your API repository.Īfter you set up a GitHub Actions integration, information for build jobs is available in Postman. Postman pre-fills a nickname in the format GitHub-, and you can edit it if you want. Teams can use other Postman accounts to create more than ten integrations.Įnter a Nickname to help you recognize the integration later.

If you create more than ten connections with the same user, the additional tokens will be revoked in the order that they were created. There's a limit of ten auth tokens per user per application imposed by GitHub. After you grant access, you can close the browser tab and return to Postman. You'll be prompted to allow Postman to access your GitHub account. To automatically create the integration, under Test and Automation, select Connect to GitHub. Tip: If you've already authenticated with GitHub to connect a Git repo for source control, you can use the same authentication. Each API can be linked to one CI project. Open your API by selecting APIs in the sidebar. To learn more, see the GitHub Actions documentation.

You define your pipeline in this YAML file. github/workflows, and then add a YAML file to the directory. To create a pipeline, create a directory in your repository named. If you haven't already, create a pipeline in the GitHub repository you use for your API. After you set up the integration, you can view the status of builds from within Postman. To set up a GitHub Actions integration for your API, first create a pipeline in GitHub and then configure your API in Postman. Software development teams can use GitHub Actions to automatically build, test, and deploy code in GitHub. GitHub Actions is a continuous integration and continuous delivery (CI/CD) service that's integrated with GitHub. GitHub Actions self-hosted runners are available on Postman Enterprise plans with the API Builder add-on.

Github api postman collection