Add workflow to check for broken links

Planeshifter · Planeshifter · commit 86facdf87642 · 2021-08-20T01:11:08.000-04:00
diff --git a/.github/workflows/broken_markdown_links.yml b/.github/workflows/broken_markdown_links.yml
@@ -0,0 +1,71 @@
+#/
+# @license Apache-2.0
+#
+# Copyright (c) 2021 The Stdlib Authors.
+#
+# 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
+#
+#    http://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.
+#/
+
+# Workflow name:
+name: broken_markdown_links
+
+# Workflow triggers:
+on:
+  schedule:
+    # Run the workflow once a month on the 1st day of every month.
+    - cron:  "0 0 1 * *"
+
+  # Allow the workflow to be manually run:
+  workflow_dispatch:
+
+# Workflow jobs:
+jobs:
+
+  # Define a job for detecting broken links in Markdown files...
+  broken_markdown_links:
+
+    # Define a display name:
+    name: 'Detect broken links in Markdown files'
+
+    # Define the type of virtual host machine:
+    runs-on: ubuntu-latest
+
+    # Define the sequence of job steps...
+    steps:
+
+      # Checkout the repository:
+      - name: 'Checkout repository'
+        uses: actions/checkout@v2
+        with:
+          # Specify whether to remove untracked files before checking out the repository:
+          clean: true
+
+          # Limit clone depth to the most recent commit:
+          fetch-depth: 1
+
+          # Specify whether to download Git-LFS files:
+          lfs: false
+        timeout-minutes: 10
+      # Run the command to check for broken links:
+      - id: broken-links
+        uses: stdlib-js/broken-markdown-url-definitions-action@v1.0
+        with:
+          directory: fixtures
+      # Print out the results:
+      - run: |
+          echo ${{ steps.broken-links.outputs.links }}
+          echo Status: ${{ steps.broken-links.outputs.status }}
+      # Fail the workflow if the status is not "success":
+      - if: ${{ steps.broken-links.outputs.status }} != 'success'
+        run: |
+          exit 1
