https://github.com/qentinelqi/qentinel-pace-action
GitHub action for running test suites in Qentinel Pace
https://github.com/qentinelqi/qentinel-pace-action
Last synced: 28 days ago
JSON representation
GitHub action for running test suites in Qentinel Pace
- Host: GitHub
- URL: https://github.com/qentinelqi/qentinel-pace-action
- Owner: qentinelqi
- License: bsd-3-clause
- Created: 2021-02-12T07:26:11.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-02-15T08:07:13.000Z (about 4 years ago)
- Last Synced: 2024-03-14T16:45:06.296Z (about 1 year ago)
- Language: JavaScript
- Size: 134 KB
- Stars: 5
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Qentinel Pace Action
This action runs a test suite in [Qentinel Pace](https://pace.qentinel.com) and
validates that it passes.
## Example usage
First create a Personal access token in Pace. You can create one for yourself
in your profile settings. After you have created the token, add it as a
[GitHub secret](https://docs.github.com/en/actions/reference/encrypted-secrets).
Then navigate to a test suite in Pace. Extract the `project_id` and the
`suite_id` from the `url` of the page:
Then in your GitHub workflow `.yaml` file:
```yaml
uses: qentinelqi/[email protected]
with:
access_token: ${{ secrets. }}
suite_id:
project_id:
```
That is all that is needed. For a concrete example, please see the `main.yml`
file
[in this repository](https://github.com/qentinelqi/qentinel-pace-action/blob/main/.github/workflows/main.yml). For general instructions on how to use GitHub
actions, see [here](https://docs.github.com/en/actions/learn-github-actions).
### Additional settings
The following optional variables can be added to the `with` section to configure
the action:
```yaml
with:
...
# Options to control step execution
wait_result: "true"
ignore_failed: "false"
# Options for the run
branch: "branch"
record: "all"
runType: "dry"
tag: "tag"
```
## Outputs
The following output variables will be set
- `build_id`: The buildId of the run
- `result`: The result of the test suite run
- `duration`: The execution time in seconds
- `link`: Link to the results
# Development
These instructions are for developing this action.
[GitHub instructions](https://docs.github.com/en/actions/creating-actions).
Note that the `node_modules` folder is included because it is required when
running JavaScript based actions.
## Testing
You can test this action outside GitHub with `mocha`.
First set proper action inputs in the `test_inputs.json` file in the root of
this repository. Then run the tests:
`mocha test`