Skip to content

Commit

Permalink
Update instructions to list requirements properly in Viewing test res…
Browse files Browse the repository at this point in the history
…ults

I mainly did this commit to format changes. Thanks to xeontem :)
  • Loading branch information
GabLeRoux committed Jan 5, 2024
1 parent 3417dce commit 2ae7bab
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions docs/03-github/03-test-runner.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -154,12 +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).
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`.
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

0 comments on commit 2ae7bab

Please sign in to comment.