Skip to content

Update README #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
willhbang merged 1 commit into from
Jun 27, 2025
Merged

Update README #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ your Ultralight instance, for best-in-class traceability.

```yaml
- if: always() # Runs even if previous steps fail
uses: ultralightlabs/ultralight-github-action@v1
uses: stingerlabs/ultralight-github-action@v1
with:
# Required.
# The command type. One of 'REPORT_TEST' or 'REPORT_COMMIT'.
Expand Down Expand Up @@ -52,22 +52,22 @@ your Ultralight instance, for best-in-class traceability.
# Recommended 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
# See https://github.com/stingerlabs/ultralight-test-project/blob/main/.github/workflows/report-commit
# for full examples conditioned on event trigger.
commit-hash:

# Recommended 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
# See https://github.com/stingerlabs/ultralight-test-project/blob/main/.github/workflows/report-commit
# for full examples conditioned on event trigger.
pr-url:

# 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
# See https://github.com/stingerlabs/ultralight-test-project/blob/main/.github/workflows/report-commit
# for full examples conditioned on event trigger.
is-merge-commit:
```
Expand All @@ -93,7 +93,7 @@ steps:
```yaml
- if: always() # Runs even if previous steps fail
id: report-commit
uses: ultralightlabs/ultralight-github-action@v1
uses: stingerlabs/ultralight-github-action@v1
with:
# Required.
# The command type. One of 'REPORT_TEST' or 'REPORT_COMMIT'.
Expand All @@ -107,35 +107,35 @@ steps:
# The variables below are included automatically in the context of `pull_request` events.
# If your build triggers off a non-`pull_request` event, you will need to supply the below variables,
# which may involve additional requests to the GitHub API.
# See https://github.com/ultralightlabs/test-project/blob/main/.github/workflows/report-commit
# See https://github.com/stingerlabs/ultralight-test-project/blob/main/.github/workflows/report-commit
# for full examples conditioned on event trigger.

# Required 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
# See https://github.com/stingerlabs/ultralight-test-project/blob/main/.github/workflows/report-commit
# for full examples conditioned on event trigger.
commit-hash:

# Required 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
# See https://github.com/stingerlabs/ultralight-test-project/blob/main/.github/workflows/report-commit
# for full examples conditioned on event trigger.
pr-url:

# 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
# See https://github.com/stingerlabs/ultralight-test-project/blob/main/.github/workflows/report-commit
# for full examples conditioned on event trigger.
pr-description-file-path: pr-body.txt

# 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
# See https://github.com/stingerlabs/ultralight-test-project/blob/main/.github/workflows/report-commit
# for full examples conditioned on event trigger.
is-merge-commit:

Expand Down