From 3e51a74b5dd85c86b08839c2411ee87b51d8c226 Mon Sep 17 00:00:00 2001 From: Damien Mathieu <42@dmathieu.com> Date: Thu, 22 Feb 2024 07:53:12 +0100 Subject: [PATCH] Add links checking actions (#5136) * add links checking github actions * fix broken links --- .github/workflows/links-fail-fast.yml | 16 ++++++++++++++++ .github/workflows/links.yml | 27 +++++++++++++++++++++++++++ CONTRIBUTING.md | 2 +- lychee.toml | 3 +++ 4 files changed, 47 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/links-fail-fast.yml create mode 100644 .github/workflows/links.yml create mode 100644 lychee.toml diff --git a/.github/workflows/links-fail-fast.yml b/.github/workflows/links-fail-fast.yml new file mode 100644 index 00000000000..12793a196cb --- /dev/null +++ b/.github/workflows/links-fail-fast.yml @@ -0,0 +1,16 @@ +name: Links (Fail Fast) + +on: + push: + pull_request: + +jobs: + check-links: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: Link Checker + uses: lycheeverse/lychee-action@v1.9.3 + with: + fail: true diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml new file mode 100644 index 00000000000..222318339ad --- /dev/null +++ b/.github/workflows/links.yml @@ -0,0 +1,27 @@ +name: Links + +on: + repository_dispatch: + workflow_dispatch: + schedule: + # Everyday at 9:00 AM. + - cron: "0 9 * * *" + +jobs: + check-links: + runs-on: ubuntu-latest + steps: + - name: Checkout Repo + uses: actions/checkout@v4 + + - name: Link Checker + id: lychee + uses: lycheeverse/lychee-action@v1.9.3 + + - name: Create Issue From File + if: steps.lychee.outputs.exit_code != 0 + uses: peter-evans/create-issue-from-file@v5 + with: + title: Link Checker Report + content-filepath: ./lychee/out.md + labels: report, bot-generated diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8a45bfc25cd..221c0c08fb5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -71,7 +71,7 @@ You can connect with us in our [slack channel](https://cloud-native.slack.com/ar The Go special interest group (SIG) meets regularly. See the OpenTelemetry [community](https://github.com/open-telemetry/community#golang-sdk) repo for information on this and other language SIGs. -See the [public meeting notes](https://docs.google.com/document/d/1A63zSWX0x2CyCK_LoNhmQC4rqhLpYXJzXbEPDUQ2n6w/edit#heading=h.9tngw7jdwd6b) for a summary description of past meetings. +See the [public meeting notes](https://docs.google.com/document/d/1E5e7Ld0NuU1iVvf-42tOBpu2VBBLYnh73GJuITGJTTU/edit#heading=h.ru7kpkv1rxlh) for a summary description of past meetings. ## Approvers and Maintainers diff --git a/lychee.toml b/lychee.toml new file mode 100644 index 00000000000..8a2e02d8943 --- /dev/null +++ b/lychee.toml @@ -0,0 +1,3 @@ +exclude_path = [ + "zpages/internal/templates/summary.html" # This template's URLs are only expected to be valid on the compiled file +]