From 8b31c27a4baaf27816a5c31685c9edc2dc20845d Mon Sep 17 00:00:00 2001 From: Twisha Bansal Date: Wed, 24 Sep 2025 14:58:04 +0530 Subject: [PATCH 1/2] ci: added a link checker for markdown files --- .github/workflows/markdown-checks.yml | 33 +++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 .github/workflows/markdown-checks.yml diff --git a/.github/workflows/markdown-checks.yml b/.github/workflows/markdown-checks.yml new file mode 100644 index 0000000..3cbacfa --- /dev/null +++ b/.github/workflows/markdown-checks.yml @@ -0,0 +1,33 @@ +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +name: Lint Markdown + +on: + pull_request: + branches: [ main ] + +jobs: + link-check: + name: Run link check + runs-on: ubuntu-latest + steps: + - name: Check out code + uses: actions/checkout@v4 + + - name: Link Checker + uses: lycheeverse/lychee-action@v2.0.2 + with: + # There is no security token. So, it would fail on any links which aren't public. + args: "--verbose --no-progress **.md" From 9d3b2d89ee52e2c06a094f37243f28b0a8dca5fd Mon Sep 17 00:00:00 2001 From: Twisha Bansal Date: Wed, 24 Sep 2025 15:37:36 +0530 Subject: [PATCH 2/2] update filepath --- .github/workflows/markdown-checks.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/markdown-checks.yml b/.github/workflows/markdown-checks.yml index 3cbacfa..331bed1 100644 --- a/.github/workflows/markdown-checks.yml +++ b/.github/workflows/markdown-checks.yml @@ -30,4 +30,4 @@ jobs: uses: lycheeverse/lychee-action@v2.0.2 with: # There is no security token. So, it would fail on any links which aren't public. - args: "--verbose --no-progress **.md" + args: "--verbose --no-progress **/*.md"