Skip to content

Commit bdbbe74

Browse files
committed
fix(actions): markdown checker
tcort/markdown-link-check#201 (comment)
1 parent 2db694d commit bdbbe74

4 files changed

Lines changed: 20 additions & 8 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ Thanks for considering a contribution to this project! 🙏
2727
* `GITHUB_REPOSITORY`: Set this to your username followed by a slash and your repository name.
2828
* e.g. `bcanseco/github-contribution-graph-action`
2929
* Again, this is only necessary when running locally.
30-
* `GITHUB_TOKEN`: Set this to [your personal access token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line).
30+
* `GITHUB_TOKEN`: Set this to [your personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
3131
* Make sure to check the **Repo** boxes.
32-
* Note that the personal access token has more permissions than the `GITHUB_TOKEN` provided by the Actions runner. Read more about this [here](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token#permissions-for-the-github_token).
32+
* Note that the personal access token has more permissions than the `GITHUB_TOKEN` provided by the Actions runner. Read more about this [here](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token).
3333
* `GIT_EMAIL`: Set this to [an email associated with your GitHub account](https://github.com/settings/emails).
3434
* `GIT_BRANCH`: Set this to `master`.
3535
1. Make sure your Docker daemon is running.
@@ -60,7 +60,7 @@ For some reason, the GitHub Actions runner mutates ISO timestamp strings passed
6060

6161
### Why use environment variables instead of [inputs][inputs]? 🔌
6262

63-
[inputs]: https://help.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputs
63+
[inputs]: https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputs
6464

6565
Two reasons:
6666

.github/workflows/build.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ jobs:
1818
steps:
1919
- uses: actions/checkout@master
2020
- uses: gaurav-nelson/github-action-markdown-link-check@v1
21+
with:
22+
config-file: markdown_link_check_config.json
2123
dogfooding:
2224
runs-on: ubuntu-latest
2325
steps:

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ Explore the [code](src/index.js)! It's tiny and there aren't many dependencies.
134134

135135
Speaking of dependencies, all production npm dependencies used by this GitHub Action are [automatically audited](./.github/workflows/audit.yml) for vulnerabilities. If the badge at the top of this README is green, you're good to go.
136136

137-
If you're still worried about malicious code in this repository, GitHub recommends always using a specific version of any GitHub Actions you add to your repositories. [Read more](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsuses).
137+
If you're still worried about malicious code in this repository, GitHub recommends always using a specific version of any GitHub Actions you add to your repositories. [Read more](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsuses).
138138

139139
```diff
140140
- uses: bcanseco/github-contribution-graph-action@v2
@@ -148,7 +148,7 @@ As far as data security, there's two sensitive pieces of data that this Action h
148148

149149
### `GITHUB_TOKEN` 🔑
150150

151-
GitHub has [a great article](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token#using-the-github_token-in-a-workflow) about the token. It's the standard way that all GitHub Actions interact with GitHub on your behalf. The permissions of this token are both short-lived and scoped to one repo only.
151+
GitHub has [a great article](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#using-the-github_token-in-a-workflow) about the token. It's the standard way that all GitHub Actions interact with GitHub on your behalf. The permissions of this token are both short-lived and scoped to one repo only.
152152

153153
You don't need to create this secret yourself; GitHub handles that for you. All you need to do is provide the token in your workflow, job, or step:
154154

@@ -159,12 +159,12 @@ env:
159159

160160
### `GIT_EMAIL` 📧
161161

162-
This GitHub Action requires an email associated with your GitHub account. If you provide a random or throwaway email, contributions won't show up on your GitHub profile. [Read more](https://help.github.com/en/github/setting-up-and-managing-your-github-profile/why-are-my-contributions-not-showing-up-on-my-profile#you-havent-added-your-local-git-commit-email-to-your-profile).
162+
This GitHub Action requires an email associated with your GitHub account. If you provide a random or throwaway email, contributions won't show up on your GitHub profile. [Read more](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile#you-havent-added-your-local-git-commit-email-to-your-profile).
163163

164164
Chances are, your email is already public if you're making commits with it. But if you're concerned about privacy, you can do either of the following:
165165

166-
* [Add your email as a secret](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets-for-a-repository) and pass it in the same way as the `GITHUB_TOKEN`
167-
* [Use your GitHub-provided `noreply` email address](https://help.github.com/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address#about-commit-email-addresses)
166+
* [Add your email as a secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) and pass it in the same way as the `GITHUB_TOKEN`
167+
* [Use your GitHub-provided `noreply` email address](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address#about-commit-email-addresses)
168168

169169
## Contribute 👪
170170

markdown_link_check_config.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"httpHeaders": [
3+
{
4+
"urls": ["https://docs.github.com/"],
5+
"headers": {
6+
"Accept-Encoding": "zstd, br, gzip, deflate"
7+
}
8+
}
9+
]
10+
}

0 commit comments

Comments
 (0)