Implement lychee-broken-link-checker to catch broken links in GitHub … (

aptos-labs#6428) * Implement lychee-broken-link-checker to catch broken links in GitHub Markdown * Change cron run temporarily to test tonight * Delete dependabot.yml from change based upon reviewer feedback --------- Co-authored-by: Clay Murphy <[email protected]>
plurigrid · Feb 6, 2023 · 5661341 · 5661341
1 parent 9dd8183
commit 5661341
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 0 deletions.
diff --git a/.github/workflows/links_checker.yml b/.github/workflows/links_checker.yml
@@ -0,0 +1,30 @@
+## Implementation of: https://github.com/marketplace/actions/lychee-broken-link-checker
+
+name: Aptos GitHub Links Checker
+
+on:
+  repository_dispatch:
+  workflow_dispatch:
+  schedule:
+    - cron: "00 18 * * *"
+
+jobs:
+  linkChecker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Link Checker
+        id: lychee
+        uses: lycheeverse/[email protected]
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+
+      - name: Create Issue From File
+        if: env.lychee_exit_code != 0
+        uses: peter-evans/create-issue-from-file@v4
+        with:
+          title: Link Checker Report
+          content-filepath: ./lychee/out.md
+          labels: report, automated issue
+          assignees: clay-aptos
diff --git a/.lycheeignore b/.lycheeignore
@@ -0,0 +1,3 @@
+file://.*
+http://localhost.*
+http://127.0.0.1.*
diff --git a/developer-docs-site/README.md b/developer-docs-site/README.md
@@ -9,6 +9,9 @@
 
 This Aptos Developer Documenatation is built using [Docusaurus 2](https://docusaurus.io/). Follow the below steps to build the docs locally to test your contribution.
 
+[![Check GitHub Links](https://github.com/aptos-labs/aptos-core/actions/workflows/links.yml/badge.svg)](https://github.com/org/repo/actions/workflows/links.yml)
+
+
 ## Installation
 
 **IMPORTANT**: These installation steps apply to macOS environment.