mirror of
https://github.com/bcanseco/github-contribution-graph-action.git
synced 2025-10-09 13:41:58 +03:00
fix(actions): markdown checker
https://github.com/tcort/markdown-link-check/issues/201#issuecomment-1110242146
This commit is contained in:
6
.github/CONTRIBUTING.md
vendored
6
.github/CONTRIBUTING.md
vendored
@@ -27,9 +27,9 @@ Thanks for considering a contribution to this project! 🙏
|
||||
* `GITHUB_REPOSITORY`: Set this to your username followed by a slash and your repository name.
|
||||
* e.g. `bcanseco/github-contribution-graph-action`
|
||||
* Again, this is only necessary when running locally.
|
||||
* `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).
|
||||
* `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).
|
||||
* Make sure to check the **Repo** boxes.
|
||||
* 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).
|
||||
* 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).
|
||||
* `GIT_EMAIL`: Set this to [an email associated with your GitHub account](https://github.com/settings/emails).
|
||||
* `GIT_BRANCH`: Set this to `master`.
|
||||
1. Make sure your Docker daemon is running.
|
||||
@@ -60,7 +60,7 @@ For some reason, the GitHub Actions runner mutates ISO timestamp strings passed
|
||||
|
||||
### Why use environment variables instead of [inputs][inputs]? 🔌
|
||||
|
||||
[inputs]: https://help.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputs
|
||||
[inputs]: https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputs
|
||||
|
||||
Two reasons:
|
||||
|
||||
|
||||
2
.github/workflows/build.yml
vendored
2
.github/workflows/build.yml
vendored
@@ -18,6 +18,8 @@ jobs:
|
||||
steps:
|
||||
- uses: actions/checkout@master
|
||||
- uses: gaurav-nelson/github-action-markdown-link-check@v1
|
||||
with:
|
||||
config-file: markdown_link_check_config.json
|
||||
dogfooding:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
|
||||
10
README.md
10
README.md
@@ -134,7 +134,7 @@ Explore the [code](src/index.js)! It's tiny and there aren't many dependencies.
|
||||
|
||||
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.
|
||||
|
||||
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).
|
||||
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).
|
||||
|
||||
```diff
|
||||
- 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
|
||||
|
||||
### `GITHUB_TOKEN` 🔑
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
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:
|
||||
|
||||
@@ -159,12 +159,12 @@ env:
|
||||
|
||||
### `GIT_EMAIL` 📧
|
||||
|
||||
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).
|
||||
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).
|
||||
|
||||
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:
|
||||
|
||||
* [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`
|
||||
* [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)
|
||||
* [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`
|
||||
* [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)
|
||||
|
||||
## Contribute 👪
|
||||
|
||||
|
||||
10
markdown_link_check_config.json
Normal file
10
markdown_link_check_config.json
Normal file
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"httpHeaders": [
|
||||
{
|
||||
"urls": ["https://docs.github.com/"],
|
||||
"headers": {
|
||||
"Accept-Encoding": "zstd, br, gzip, deflate"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
Reference in New Issue
Block a user