From 3e3974372ee1172e58ab75713cc8e291e7b8012e Mon Sep 17 00:00:00 2001 From: Will Gibson <8738245+WillGibson@users.noreply.github.com> Date: Tue, 13 May 2025 09:57:58 +0100 Subject: [PATCH 1/3] Correct some instructions in the README.md --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 8d55b07..fa7c67d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ ### GitHub Action - Markdown link check 🔗✔️ [![GitHub Marketplace](https://img.shields.io/badge/GitHub%20Marketplace-Markdown%20link%20check-brightgreen?style=for-the-badge)](https://github.com/marketplace/actions/markdown-link-check-action) -Forked from [gaurav-nelson/github-action-markdown-link-check](https://github.com/gaurav-nelson/github-action-markdown-link-check), which is no longer maintained. +> Forked from [gaurav-nelson/github-action-markdown-link-check](https://github.com/gaurav-nelson/github-action-markdown-link-check), which is no longer maintained. This GitHub action checks all Markdown files in your repository for broken links. (Uses [tcort/markdown-link-check](https://github.com/tcort/markdown-link-check)) @@ -18,8 +18,8 @@ This GitHub action checks all Markdown files in your repository for broken links markdown-link-check: runs-on: ubuntu-latest steps: - - uses: actions/checkout@master - - uses: tcort/github-action-markdown-link-check@v1 + - uses: actions/checkout@v4 + - uses: tcort/github-action-markdown-link-check@v1.1.0 ``` ### Real-life usage samples @@ -71,8 +71,8 @@ jobs: markdown-link-check: runs-on: ubuntu-latest steps: - - uses: actions/checkout@master - - uses: tcort/github-action-markdown-link-check@v1 + - uses: actions/checkout@v4 + - uses: tcort/github-action-markdown-link-check@v1.1.0 with: use-quiet-mode: 'yes' use-verbose-mode: 'yes' @@ -104,8 +104,8 @@ jobs: markdown-link-check: runs-on: ubuntu-latest steps: - - uses: actions/checkout@master - - uses: tcort/github-action-markdown-link-check@v1 + - uses: actions/checkout@v4 + - uses: tcort/github-action-markdown-link-check@v1.1.0 with: use-quiet-mode: 'yes' use-verbose-mode: 'yes' @@ -152,8 +152,8 @@ jobs: markdown-link-check: runs-on: ubuntu-latest steps: - - uses: actions/checkout@master - - uses: tcort/github-action-markdown-link-check@v1 + - uses: actions/checkout@v4 + - uses: tcort/github-action-markdown-link-check@v1.1.0 with: use-quiet-mode: 'yes' use-verbose-mode: 'yes' @@ -170,8 +170,8 @@ jobs: markdown-link-check: runs-on: ubuntu-latest steps: - - uses: actions/checkout@master - - uses: tcort/github-action-markdown-link-check@v1 + - uses: actions/checkout@v4 + - uses: tcort/github-action-markdown-link-check@v1.1.0 with: use-quiet-mode: 'yes' folder-path: 'md/dir1, md/dir2' @@ -220,11 +220,11 @@ jobs: runs-on: ubuntu-latest # check out the latest version of the code steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 # Checks the status of hyperlinks in .md files in verbose mode - name: Check links - uses: tcort/github-action-markdown-link-check@v1 + uses: tcort/github-action-markdown-link-check@v1.1.0 with: use-verbose-mode: 'yes' ``` @@ -242,11 +242,11 @@ GitHub Action - Markdown link check follows the [GitHub recommended versioning s 1. To use a specific released version of the action ([Releases](https://github.com/tcort/github-action-markdown-link-check/releases)): ```yml - - uses: tcort/github-action-markdown-link-check@1 + - uses: tcort/github-action-markdown-link-check@1.1.0 ``` 1. To use a major version of the action: ```yml - - uses: tcort/github-action-markdown-link-check@v1 + - uses: tcort/github-action-markdown-link-check@v1.1.0 ``` 1. You can also specify a [specific commit SHA](https://github.com/tcort/github-action-markdown-link-check/commits/master) as an action version: ```yml From 5fbfdf78988571d54281a12032ccecb271509578 Mon Sep 17 00:00:00 2001 From: Will Gibson <8738245+WillGibson@users.noreply.github.com> Date: Tue, 13 May 2025 12:07:34 +0100 Subject: [PATCH 2/3] Revert to v1 --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index fa7c67d..a1e73b3 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ This GitHub action checks all Markdown files in your repository for broken links runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: tcort/github-action-markdown-link-check@v1.1.0 + - uses: tcort/github-action-markdown-link-check@v1 ``` ### Real-life usage samples @@ -72,7 +72,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: tcort/github-action-markdown-link-check@v1.1.0 + - uses: tcort/github-action-markdown-link-check@v1 with: use-quiet-mode: 'yes' use-verbose-mode: 'yes' @@ -105,7 +105,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: tcort/github-action-markdown-link-check@v1.1.0 + - uses: tcort/github-action-markdown-link-check@v1 with: use-quiet-mode: 'yes' use-verbose-mode: 'yes' @@ -153,7 +153,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: tcort/github-action-markdown-link-check@v1.1.0 + - uses: tcort/github-action-markdown-link-check@v1 with: use-quiet-mode: 'yes' use-verbose-mode: 'yes' @@ -171,7 +171,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: tcort/github-action-markdown-link-check@v1.1.0 + - uses: tcort/github-action-markdown-link-check@v1 with: use-quiet-mode: 'yes' folder-path: 'md/dir1, md/dir2' @@ -224,7 +224,7 @@ jobs: # Checks the status of hyperlinks in .md files in verbose mode - name: Check links - uses: tcort/github-action-markdown-link-check@v1.1.0 + uses: tcort/github-action-markdown-link-check@v1 with: use-verbose-mode: 'yes' ``` @@ -242,11 +242,11 @@ GitHub Action - Markdown link check follows the [GitHub recommended versioning s 1. To use a specific released version of the action ([Releases](https://github.com/tcort/github-action-markdown-link-check/releases)): ```yml - - uses: tcort/github-action-markdown-link-check@1.1.0 + - uses: tcort/github-action-markdown-link-check@v1 ``` 1. To use a major version of the action: ```yml - - uses: tcort/github-action-markdown-link-check@v1.1.0 + - uses: tcort/github-action-markdown-link-check@v1 ``` 1. You can also specify a [specific commit SHA](https://github.com/tcort/github-action-markdown-link-check/commits/master) as an action version: ```yml From 98a8386f721d8e3e9c2b8748cb577f74a0cf91fe Mon Sep 17 00:00:00 2001 From: Will Gibson <8738245+WillGibson@users.noreply.github.com> Date: Tue, 13 May 2025 12:13:06 +0100 Subject: [PATCH 3/3] Remove realworld examples as full of dead links --- README.md | 13 ------------- 1 file changed, 13 deletions(-) diff --git a/README.md b/README.md index a1e73b3..1e1a8c6 100644 --- a/README.md +++ b/README.md @@ -22,19 +22,6 @@ This GitHub action checks all Markdown files in your repository for broken links - uses: tcort/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. [netdata](https://github.com/netdata/netdata/blob/master/.github/workflows/docs.yml) ![](https://img.shields.io/github/stars/netdata/netdata?style=social) -1. [GoogleChrome/lighthouse (Weekly cron job)](https://github.com/GoogleChrome/lighthouse/blob/master/.github/workflows/cron-weekly.yml) - ![](https://img.shields.io/github/stars/GoogleChrome/lighthouse?style=social) -1. [tendermint/tendermint](https://github.com/tendermint/tendermint/blob/master/.github/workflows/markdown-links.yml) - ![](https://img.shields.io/github/stars/tendermint/tendermint?style=social) -1. [pyroscope-io/pyroscope](https://github.com/pyroscope-io/pyroscope/blob/main/.github/workflows/lint-markdown.yml) - ![](https://img.shields.io/github/stars/pyroscope-io/pyroscope?style=social) - ## Configuration - [Custom variables](#custom-variables)