stingerlabs/Ultralight Github Action
Reports code commits, test protocols, and test executions to your Ultralight instance
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| command | The command type. One of 'REPORT_TEST' or 'REPORT_COMMIT'. | no | REPORT_TEST |
| ultralight-api-key | This can be generated in the Ultralight web app's settings page. Store this as a secret. | yes | — |
| commit-hash | Required for REPORT_COMMIT command and recommended for REPORT_TEST command (to enable Release module integrations) if your trigger is not a `pull_request` event. Commit hash queried from your github action context. Query method varies depending on your workflow's event trigger. See https://github.com/ultralightlabs/test-project/blob/main/.github/workflows/report-commit for full examples conditioned on event trigger. | no | — |
| pr-url | Required for REPORT_COMMIT command and recommended for REPORT_TEST command (to enable Release module integrations) if your trigger is not a `pull_request` event. PR URL queried from your github action context. Query method varies depending on your workflow's event trigger. See https://github.com/ultralightlabs/test-project/blob/main/.github/workflows/report-commit for full examples conditioned on event trigger. | no | — |
| ultralight-product-id | Required for command=REPORT_TEST. The ID of your Ultralight product. You can find this in your browser URL when viewing your product in the Ultralight web app: https://app.ultralightlabs.com/[organization-name]/products/[ultralight-product-id]. Store this as a secret. | no | — |
| test-execution-report-path | Path to the test execution report file. The Ultralight API supports the JUnit XML format for test execution reports. Most testing frameworks provide mechanisms to output in JUnit, either in-built or via plugins. Every test case in the test execution output must include the ID of an existing Verification (e.g. VER-1) or Validation (e.g. VAL-2) in your Ultralight Design Controls instance. | no | — |
| test-execution-unit-under-test | Custom name for the unit under test to display in generated test reports | no | — |
| test-protocol-definitions-directory-path | Path to the directory holding the YAML files for your test protocol definitions. Every test protocol must be an existing Verification (e.g. VER-1) or Validation (e.g. VAL-2) in your Ultralight Design Controls instance. | no | — |
| pr-description-file-path | Required if your trigger is not a `pull_request` event. PR description queried from your github action context. Query method varies depending on your workflow's event trigger. See https://github.com/ultralightlabs/test-project/blob/main/.github/workflows/report-commit for full examples conditioned on event trigger. | no | — |
| is-merge-commit | Can be supplied optionally if your trigger is not a `pull_request` event. Whether the supplied commit is a `merge` commit, queried from your github action context. Query method varies depending on your workflow's event trigger. Updating an approved Software Part Version with a merge commit will NOT withdraw approval for that Software Part Version. See https://github.com/ultralightlabs/test-project/blob/main/.github/workflows/report-commit for full examples conditioned on event trigger. | no | — |
| ultralight-url | For internal testing only. | no | https://app.ultralightlabs.com |
Outputs
| name | description |
|---|---|
| merge-allowed | Whether release prerequisites have been met on linked Ultralight Releases. |
| report-commit-data | Results of the commit report and merge block context, as a JSON string. |