Skip to content
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

Update 03-test-runner.mdx #446

Merged
merged 3 commits into from
Jan 5, 2024
Merged

Update 03-test-runner.mdx #446

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ed8348d
Update 03-test-runner.mdx
xeontem Jan 1, 2024
3417dce
Update 03-test-runner.mdx
xeontem Jan 4, 2024
2ae7bab
Update instructions to list requirements properly in Viewing test res…
GabLeRoux Jan 5, 2024
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
13 changes: 9 additions & 4 deletions docs/03-github/03-test-runner.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,10 +154,15 @@ potential workarounds.
The test results can be viewed from a
[GitHub Status Check](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-status-checks).

To get this functionality, simply provide the
[GitHub Token](https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret)
in order to view the tests results from
[a check run](https://docs.github.com/en/rest/guides/getting-started-with-the-checks-api#about-check-runs).
To get this functionality, you need to do the following:

1. Provide a
[GitHub Token](https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret)
in order to view the tests results from
[a check run](https://docs.github.com/en/rest/guides/getting-started-with-the-checks-api#about-check-runs).
2. Provide write permissions for your workflow: go to `Settings` > `Actions` > `General` >
`Workflow permissions` and choose `Read and write permissions`. By default it is set to
`Read repository content and packages permissions`.

```yaml
- uses: game-ci/unity-test-runner@v4
Expand Down