Skip to content

Commit eee0ca4

Browse files
edumserranoedumserrano
committed
update workflow and docs due to GITHUB_TOKEN working again
1 parent c98618d commit eee0ca4

File tree

3 files changed

+1
-27
lines changed

3 files changed

+1
-27
lines changed

‎README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,6 @@ jobs:
8080
id: mlc-log-parser
8181
uses: edumserrano/markdown-link-check-log-parser@v1
8282
with:
83-
auth-token: <token with repo scope, see action inputs section below>
8483
run-id: '${{ github.event.workflow_run.id }}'
8584
job-name: 'Run Markdown Link Check'
8685
step-name: 'Markdown Link Check'
@@ -117,7 +116,7 @@ Error:
117116
<!-- the &nbsp; is a trick to expand the width of the table column. You add as many &nbsp; as required to get the width you want. -->
118117
| Name &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; | Description | Required | Default |
119118
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ---------------------------------------- |
120-
| `auth-token` | GitHub token used to access workflow run logs (GITHUB_TOKEN or a repo scoped PAT). See warning below. | yes | `github.token` (job token) |
119+
| `auth-token` | GitHub token used to access workflow run logs (GITHUB_TOKEN or a repo scoped PAT). | yes | `github.token` (job token) |
121120
| `repo` | The full name of the repository for the workflow run in the format of {owner}/{repo}. | yes | `github.repository` (current repository) |
122121
| `run-id` | The unique identifier of the workflow run that contains the markdown link check step. | yes | --- |
123122
| `job-name` | The name of the job that contains the markdown link check step. | yes | --- |
@@ -127,10 +126,6 @@ Error:
127126
| `json-filepath` | The filepath for the output JSON file, relative to the github workspace folder. | no | --- |
128127
| `markdown-filepath` | The filepath for the output markdown file, relative to the github workspace folder. | no | --- |
129128
130-
> **Warning**
131-
>
132-
> The default value for `auth-token` action input might not work. In some scenarios I was getting a 500 when trying to download workflow run logs using the GITHUB_TOKEN. If you get a similar error consider using a custom PAT with repo scoped permissions.
133-
134129
| Output option | Description |
135130
| ------------- | --------------------------------------------------------------------------------------------------------------------------- |
136131
| `step-json` | Writes the log parser result as JSON to the step's outputs. Cannot be specified in combination with `step-md` option. |

‎docs/dev-notes/workflows/test-action-gh-marketplace-workflow.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,3 @@
88
- The main difference from this workflow and the `test-action workflow` are:
99
- Tests the GitHub action from the Marketplace instead of building it from this repo. It makes sure that the published version is working.
1010
- Does not update a PR status because this is not a workflow that should add a status checks to PRs.
11-
12-
## Secrets
13-
14-
This workflow uses a custom secret `TEST_GITHUB_ACTION_GH_TOKEN`. This secret contains a GitHub token with permissions to access public repositories and has no expiration date. This token is required to run the app on this `test-action` workflow.
15-
16-
> **Note**
17-
>
18-
> Before the `GITHUB_TOKEN` from the workflow run was enough, there was no need for a custom token. However, around the time of commit 42bd774ebbf09450a4e7a2dcad33cc17995aa5af, the app started failing due to a `500` when downloading workflow run logs using the `GITHUB_TOKEN`.
19-
>
20-
> Couldn't find any information as to what might have changed in GitHub to cause this so I decided to fix the problem using a custom token. However, in the future, I might try again using the `GITHUB_TOKEN` to see if the problem has been remediated.

‎docs/dev-notes/workflows/test-action-workflow.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,3 @@ Since this workflow executes the [Docker container action](https://docs.github.c
2020
> The downside of this approach is that I need to keep both `action.yml` files, the one at the root of the repo and the one at `/action-local`, in sync.
2121
>
2222
> Alternativel, I could try to setup the workflows so that this test workflow only runs after the Docker image has been published. However this approach also has problems to solve such as making sure that the checks work as expected in a pull request scenario. The current approach eliminates all problems of this type with the only downside of keeping the `action.yml` files in sync.
23-
24-
## Secrets
25-
26-
This workflow uses a custom secret `TEST_GITHUB_ACTION_GH_TOKEN`. This secret contains a GitHub token with permissions to access public repositories and has no expiration date. This token is required to run the app on this `test-action` workflow.
27-
28-
> **Note**
29-
>
30-
> Before the `GITHUB_TOKEN` from the workflow run was enough, there was no need for a custom token. However, around the time of commit 42bd774ebbf09450a4e7a2dcad33cc17995aa5af, the app started failing due to a `500` when downloading workflow run logs using the `GITHUB_TOKEN`.
31-
>
32-
> Couldn't find any information as to what might have changed in GitHub to cause this so I decided to fix the problem using a custom token. However, in the future, I might try again using the `GITHUB_TOKEN` to see if the problem has been remediated.
33-

0 commit comments

Comments
 (0)