Add Markdown link check action (#32)

Automatically check links in markdown files on any push and also every Sunday at 9AM (UTC?).
camerondurham · Feb 5, 2022 · 5c04649 · 5c04649
1 parent 4bb7503
commit 5c04649
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 1 deletion.
diff --git a/.github/workflows/markdown-links.yml b/.github/workflows/markdown-links.yml
@@ -0,0 +1,14 @@
+name: Check Markdown links
+
+on:
+  push:
+  schedule:
+    # run every Sunday at 9:00AM (see https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html#tag_20_25_07)
+    - cron: '0 9 * * 0'
+
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - uses: gaurav-nelson/github-action-markdown-link-check@v1
diff --git a/.github/workflows/test.yaml → .github/workflows/test.yml b/.github/workflows/test.yaml → .github/workflows/test.yml
diff --git a/README.md b/README.md
@@ -31,7 +31,6 @@ This was designed to generalize how we develop C++ code in CSCI 104 to be portab
 whichever Docker container you choose. Of course, this project would not be possible without the reference
 of [docker/cli](https://github.com/docker/cli) for examples of how to use the Docker Engine API.
 
-
 ## Installation
 
 You can follow the installation instructions below to install