GitHub Action for BuildPulse

Easily connect your GitHub Actions CI workflows to BuildPulse to help you identify and eliminate flaky tests.

Usage

Locate the BuildPulse credentials for your account at buildpulse.io
In the GitHub settings for your repository, create an encrypted secret named BUILDPULSE_ACCESS_KEY_ID and set its value to the BUILDPULSE_ACCESS_KEY_ID for your account
Create another encrypted secret named BUILDPULSE_SECRET_ACCESS_KEY and set its value to the BUILDPULSE_SECRET_ACCESS_KEY for your account

Add a step to your GitHub Actions workflow to use this action to send your test results to BuildPulse:

steps:
- name: Check out code
  uses: actions/checkout@v2

- name: Run tests
  run: echo "Run your tests and generate XML reports for your test results"

- name: Upload test results to BuildPulse for flaky test detection
  if: '!cancelled()' # Run this step even when the tests fail. Skip if the workflow is cancelled.
  uses: buildpulse/buildpulse-action@main
  with:
    account: <buildpulse-account-id>
    repository: <buildpulse-repository-id>
    path: <path-to-xml-reports>
    key: ${{ secrets.BUILDPULSE_ACCESS_KEY_ID }}
    secret: ${{ secrets.BUILDPULSE_SECRET_ACCESS_KEY }}

Inputs

`account`

Required The unique numeric identifier for the BuildPulse account that owns the repository.

`repository`

Required The unique numeric identifier for the repository being built.

`path`

Required The path to the XML file(s) for the test results. Can be a directory (e.g., test/reports), a single file (e.g., reports/junit.xml), or a glob (e.g., app/*/results/*.xml).

`key`

Required The BUILDPULSE_ACCESS_KEY_ID for the account that owns the repository.

`secret`

Required The BUILDPULSE_SECRET_ACCESS_KEY for the account that owns the repository.

`commit`

Optional The SHA for the commit that produced the test results (default: the value of ${{ github.sha }}, which is the commit that triggered the workflow).

If your workflow checks out a different commit than the commit that triggered the workflow, then use this input to specify the commit SHA that your workflow checked out. For example, if your workflow is triggered by the pull_request event, but you customize the workflow to check out the pull request HEAD commit, then you'll want to set this input to the pull request HEAD commit SHA.

`repository-path`

Optional The path to the local git clone of the repository (default: ".").

helsont / buildpulse-action