https://github.com/buildpulse/buildpulse-action

GitHub Action for connecting to BuildPulse for flaky test detection
https://github.com/buildpulse/buildpulse-action

actions

Last synced: 8 days ago
JSON representation

GitHub Action for connecting to BuildPulse for flaky test detection

• Host: GitHub
• URL: https://github.com/buildpulse/buildpulse-action
• Owner: buildpulse
• License: mit
• Created: 2022-11-30T12:59:57.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-08T14:44:55.000Z (8 months ago)
• Last Synced: 2024-10-08T19:32:21.338Z (about 1 month ago)
• Topics: actions
• Language: Shell
• Homepage:
• Size: 43.9 KB
• Stars: 5
• Watchers: 0
• Forks: 5
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitHub Action for BuildPulse [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/buildpulse/buildpulse-action/main/LICENSE)

Easily connect your GitHub Actions CI workflows to [BuildPulse][buildpulse.io] to help you find and [fix flaky tests](https://buildpulse.io/products/flaky-tests).

## Usage

1. Locate the BuildPulse credentials for your account at [buildpulse.io][]

2. In the GitHub settings for your repository, [create an encrypted secret](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets) named `BUILDPULSE_ACCESS_KEY_ID` and set its value to the `BUILDPULSE_ACCESS_KEY_ID` for your account

3. Create another encrypted secret named `BUILDPULSE_SECRET_ACCESS_KEY` and set its value to the `BUILDPULSE_SECRET_ACCESS_KEY` for your account

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

    ```yaml

    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: 

        repository: 

        path: |

          reports/junit.xml # 

          reports2/**/junit.xml # support double globbing (if your github-hosted runner OS uses bash 4+)

        key: ${{ secrets.BUILDPULSE_ACCESS_KEY_ID }}

        secret: ${{ secrets.BUILDPULSE_SECRET_ACCESS_KEY }}

        coverage-files: coverage/report.xml # IF PURCHASED

        tags: e2e team1 staging # OPTIONAL

    ```

## 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 }}`](https://docs.github.com/en/actions/learn-github-actions/contexts#github-context), 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](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request), but you [customize the workflow to check out the pull request HEAD commit](https://github.com/actions/checkout/tree/v3.0.2#checkout-pull-request-head-commit-instead-of-merge-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: ".").

### `coverage-files`

_Optional_ The paths to the coverage file(s) for the test results (space-separated).

### `tags`

_Optional_ Tags to apply to this build (space-separated).

### `quota`

_Optional_ Quota ID to count this upload against. Please set on BuildPulse Dashboard first.

[buildpulse.io]: https://buildpulse.io