Skip to content

Update README.md - fix anchor link (#36903) #65677

Update README.md - fix anchor link (#36903)

Update README.md - fix anchor link (#36903) #65677

Workflow file for this run

name: check-links
on:
push:
branches: [ main ]
pull_request:
# Do not cancel this workflow on main. See https://github.com/open-telemetry/opentelemetry-collector-contrib/pull/16616
concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
cancel-in-progress: true
env:
# renovate: datasource=github-releases depName=tcort/markdown-link-check
MD_LINK_CHECK_VERSION: "3.12.2"
jobs:
changedfiles:
name: changed files
runs-on: ubuntu-24.04
if: ${{ github.actor != 'dependabot[bot]' }}
outputs:
md_files: ${{ steps.changed-files.outputs.md_all_changed_files }}
yaml_files: ${{ steps.changed-files.outputs.yaml_all_changed_files }} # used to catch MD_LINK_CHECK_VERSION updates and runs check-links to confirm functionality
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Get changed files
id: changed-files
uses: tj-actions/changed-files@v45
with:
files_yaml: |
md:
- '**.md'
yaml:
- .github/workflows/check-links.yaml
check-links:
runs-on: ubuntu-24.04
needs: changedfiles
if: needs.changedfiles.outputs.md_files || needs.changedfiles.outputs.yaml_files
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Install markdown-link-check
run: npm install -g markdown-link-check@${{ env.MD_LINK_CHECK_VERSION }}
- name: Run markdown-link-check
run: |
if [ -n "${{ needs.changedfiles.outputs.yaml_files }}" ]; then
md=$(find . -type f -name "*.md")
else
md="${{ needs.changedfiles.outputs.md_files }}"
fi
markdown-link-check \
--verbose \
--config .github/workflows/check_links_config.json \
$md \
|| { echo "Check that anchor links are lowercase"; exit 1; }