https://github.com/prodigyeducation/qawolf-greenlight

A custom GitHub Action to integrate into QAWolf
https://github.com/prodigyeducation/qawolf-greenlight

Last synced: 5 days ago
JSON representation

A custom GitHub Action to integrate into QAWolf

• Host: GitHub
• URL: https://github.com/prodigyeducation/qawolf-greenlight
• Owner: prodigyeducation
• License: mit
• Created: 2024-07-26T20:01:50.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-07-31T20:14:18.000Z (5 months ago)
• Last Synced: 2024-11-06T03:28:18.590Z (about 2 months ago)
• Language: JavaScript
• Homepage:
• Size: 682 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# QAWolf Greenlight

This GitHub Action integrates with QAWolf, an end-to-end testing platform, to validate QAWolf test suites and retrieve the status of a workflow run.

## Installation

To use this GitHub Action, follow these steps:

1. Clone the repository: `git clone https://github.com/prodigyeducation/qawolf-greenlight.git`

## Usage

To use this action in your workflow, add the following step to your GitHub Actions workflow file:

```yaml

- name: QAWolf Greenlight

  uses: prodigyeducation/qawolf-greenlight@v1

  with:

    qawolf-api-key: ${{ secrets.QAWOLF_API_KEY }}

    qawolf-notification-config: '{ "branch": "main", "deploymentType": "staging" }'

    timeout: 600 # Optional, default is 600 seconds

    interval: 30 # Optional, default is 30 seconds

```

## Inputs

- `qawolf-api-key` (required): The QAWolf API key.

- `qawolf-notification-config` (required): The QAWolf Notification Config, see typing for[DeployConfig](https://www.npmjs.com/package/@qawolf/ci-sdk).

- `timeout` (optional): The timeout for the test run in seconds (must be divisible by `inputs.interval`). Default is 600 seconds.

- `interval` (optional): The interval to retry. Default is 30 seconds.

## Outputs

- `status`: The status of the test run. 'success' or 'failure' or 'timeout' or 'cancelled'

- `blockingBugsCount`: The number of blocking bugs.

- `nonBlockingBugsCount`: The number of non-blocking bugs.

- `numWorkflowsRun`: The number of workflows run.

- `bugs`: The number of reproduced bugs in JSON format.

## Contributing

Contributions are welcome! If you encounter any issues or have suggestions for improvements, please open an issue or submit a pull request.