Skip to content

Commit

Permalink
Add links checking actions (#5136)
Browse files Browse the repository at this point in the history
* add links checking github actions
* fix broken links
  • Loading branch information
dmathieu authored Feb 22, 2024
1 parent 1dc457c commit b39c371
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 1 deletion.
16 changes: 16 additions & 0 deletions .github/workflows/links-fail-fast.yml
Original file line number Diff line number Diff line change
@@ -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/[email protected]
with:
fail: true
27 changes: 27 additions & 0 deletions .github/workflows/links.yml
Original file line number Diff line number Diff line change
@@ -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/[email protected]

- 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
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
3 changes: 3 additions & 0 deletions lychee.toml
Original file line number Diff line number Diff line change
@@ -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
]

0 comments on commit b39c371

Please sign in to comment.