gaurav-nelson/github-action-markdown-link-check
1
1
Fork 0
mirror of https://github.com/gaurav-nelson/github-action-markdown-link-check.git synced 2024-11-25 19:13:43 +03:00
Code Issues Projects Releases Wiki Activity

Update README, fixed LICENSE

Browse Source
This commit is contained in:
Gaurav Nelson 2021-01-11 15:56:42 +10:00
parent 0fe4911067
commit 4d5a901466
2 changed files with 34 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
LICENSE
View File

@ -1,21 +1,20 @@
MIT License MIT License
Copyright (c) 2019 Gaurav Nelson Copyright (c) 2021 Gaurav Nelson
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy of
of this software and associated documentation files (the "Software"), to deal this software and associated documentation files (the "Software"), to deal in
in the Software without restriction, including without limitation the rights the Software without restriction, including without limitation the rights to
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
copies of the Software, and to permit persons to whom the Software is the Software, and to permit persons to whom the Software is furnished to do so,
furnished to do so, subject to the following conditions: subject to the following conditions:
The above copyright notice and this permission notice shall be included in all The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
SOFTWARE.

34
README.md
View File

@ -20,6 +20,20 @@ This GitHub action checks all Markdown files in your repository for broken links
- uses: gaurav-nelson/github-action-markdown-link-check@v1 - uses: gaurav-nelson/github-action-markdown-link-check@v1
``` ```
### Real-life usage samples
Following is a list of some of the repositories which are using GitHub Action -
Markdown link check.
1. [GoogleChrome/lighthouse](https://github.com/GoogleChrome/lighthouse/blob/master/.github/workflows/check-md-links.yml)
![](https://img.shields.io/github/stars/GoogleChrome/lighthouse?style=social)
1. [hashicorp/packer](https://github.com/hashicorp/packer/blob/master/.github/workflows/linkchecker.yml)
![](https://img.shields.io/github/stars/hashicorp/packer?style=social)
1. [prometheus-operator](https://github.com/prometheus-operator/prometheus-operator/blob/master/.github/workflows/ci.yaml#L29)
![](https://img.shields.io/github/stars/prometheus-operator/prometheus-operator?style=social)
1. [apache/apisix](https://github.com/apache/apisix/blob/master/.github/workflows/markdown-link-checker.yml)
![](https://img.shields.io/github/stars/apache/apisix?style=social)
## Configuration ## Configuration
- [Custom variables](#custom-variables) - [Custom variables](#custom-variables)
@ -165,6 +179,13 @@ jobs:
Use `retryOn429`, `retry-after`, `retryCount`, and `fallbackRetryDelay` in your custom configuration file. Use `retryOn429`, `retry-after`, `retryCount`, and `fallbackRetryDelay` in your custom configuration file.
See https://github.com/tcort/markdown-link-check#config-file-format for details. See https://github.com/tcort/markdown-link-check#config-file-format for details.
Or mark 429 status code as alive:
```json
{
"aliveStatusCodes": [429, 200]
}
```
## Versioning ## Versioning
GitHub Action - Markdown link check follows the [GitHub recommended versioning strategy](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md). GitHub Action - Markdown link check follows the [GitHub recommended versioning strategy](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md).
@ -180,16 +201,3 @@ GitHub Action - Markdown link check follows the [GitHub recommended versioning s
```yml ```yml
- uses: gaurav-nelson/github-action-markdown-link-check@44a942b2f7ed0dc101d556f281e906fb79f1f478 - uses: gaurav-nelson/github-action-markdown-link-check@44a942b2f7ed0dc101d556f281e906fb79f1f478
``` ```
## Real-life usage samples
Following is a list of some of the repositories which are using GitHub Action -
Markdown link check.
| Repository| Stars | Workflow file |
|:----------|:--------------|:------------|
|https://github.com/tendermint/tendermint|[![GitHub stars](https://img.shields.io/github/stars/tendermint/tendermint?style=social)](https://github.com/tendermint/tendermint/stargazers)| https://github.com/tendermint/tendermint/blob/master/.github/workflows/linkchecker.yml|
|https://github.com/stoplightio/prism|[![GitHub stars](https://img.shields.io/github/stars/stoplightio/prism?style=social)](https://github.com/stoplightio/prism/stargazers)| https://github.com/stoplightio/prism/blob/master/.github/workflows/markdown-links.yml|
## Licence
This package is [Treeware](https://treeware.earth). If you use it in production, then we ask that you [**buy the world a tree**](https://plant.treeware.earth/gaurav-nelson/github-action-markdown-link-check) to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.