From 2ae7bab095a796bbf2857e730a5564f9ade59d24 Mon Sep 17 00:00:00 2001 From: Gabriel Le Breton Date: Fri, 5 Jan 2024 12:15:48 -0500 Subject: [PATCH] Update instructions to list requirements properly in Viewing test results I mainly did this commit to format changes. Thanks to xeontem :) --- docs/03-github/03-test-runner.mdx | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/03-github/03-test-runner.mdx b/docs/03-github/03-test-runner.mdx index 81256270..b6cd7d8a 100644 --- a/docs/03-github/03-test-runner.mdx +++ b/docs/03-github/03-test-runner.mdx @@ -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