Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add nightly link checks #686

Merged
merged 8 commits into from
Apr 28, 2022
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions .github/scripts/muffet.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/bin/bash

# This script is used in Github Actions to do link checking on commits to branches and main, so
# This script is used in Github Actions to do link checking on commits to branches and master, so
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

main, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

d'oh! fixed in 367f835 and 39f0f5d

# please edit with care! See ../workflows/ci.yml for specific usage.
#
# If you're doing local development and want to run link checkers locally, please use this script!
Expand All @@ -16,7 +16,7 @@

muffet http://localhost:1313 \
--buffer-size 50000 \
--timeout 35 \
--timeout 10 \
--concurrency 2 \
--ignore-fragments \
--exclude ".*demo\.app\.medicmobile\.org.*" \
Expand All @@ -26,6 +26,8 @@ muffet http://localhost:1313 \
--exclude "https://github\.com/medic/cht-core/issues/new.*" \
--exclude "https://github\.com/medic/cht-docs/commit.*" \
--exclude "https://github\.com/medic/cht-core/commit.*" \
--exclude "https://github\.com/medic/cht-docs/edit/main/.*" \
--exclude ".*localhost:5984.*" \
--exclude "https://docs.google.com/spreadsheets/d/12345ABCDEF/edit#gid=555666888"
--exclude "https://github\.com/medic/cht-docs/edit/master/.*" \
--exclude "http[s]*://localhost[8443|5984]*" \
--exclude "http[s]*://cht\.domain\.com.*" \
--exclude "http[s]*://127\.0\.0*" \
--exclude "https://docs.google.com/spreadsheets/d/12345ABCDEF/.*"
71 changes: 71 additions & 0 deletions .github/workflows/daily.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Notes:
# - All software installed below is pinned so they don't get upgraded and break w/o us knowing why.
# - If you bump one version up to latest, please bump them all so we stay current!
# - Hugo builds the site twice: once for link checking and once minified for pushing live
# - Bash script for muffet is intentionally stand alone so devs/content editors can easily run it locally

on:
schedule:
# * is a special character in YAML so you have to quote this string
# runs at 3:15am every day:
# - cron: '15 3 * * *'
# runs every 5 min
- cron: '*/5 * * * *'

name: Test site and push live if we're on Master
jobs:
BuildLinkCheckPushLive:
name:
runs-on: ubuntu-18.04
timeout-minutes: 15
steps:

- name: All Branches - Git checkout, including recursive call for Docsy theme
uses: actions/checkout@v2
with:
submodules: recursive # Fetch the Docsy theme
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod

- name: All Branches - Install hugo extended v0.71.1
uses: peaceiris/actions-hugo@v2
with:
hugo-version: "0.71.1"
extended: true

- name: All Branches - Install Node 12.x
uses: actions/setup-node@v1
with:
node-version: '12.x'

- name: All Branches - Install npm modules for Hugo
run: npm install

- name: All Branches - Install Go v1.18
uses: actions/setup-go@v2
with:
go-version: '1.18'

- name: All Branches - Install Muffet v1.5.7
run: GO111MODULE=on go install github.com/raviqqe/[email protected]

# run in background so CI doesn't hang waiting for "ctrl + c". Sleep ensures server is ready in next step
- name: All Branches - Serve Hugo site
run: |
hugo server&
sleep 5

- name: All Branches - Run Muffet link checker
shell: bash
run: ./.github/scripts/muffet.sh

- name: Master Branch Only - Report errors to Slack, if any
if: ${{ github.ref == 'refs/heads/master' && failure() }}
uses: rtCamp/[email protected]
env:
SLACK_WEBHOOK: '${{ secrets.SLACK_WEB_HOOK }}'
SLACK_CHANNEL: '#cht-squad-docs'
SLACK_COLOR: '#3278BD'
SLACK_ICON: ":flappingphone:"
SLACK_MESSAGE: 'Broken Links Found'
SLACK_TITLE: CHT DOCS BAD LINKS
SLACK_USERNAME: Medic-Bot