Skip to content

Commit

Permalink
Merge pull request #1027 from DDMAL/broken-link-checker
Browse files Browse the repository at this point in the history
Add link checker for testing
  • Loading branch information
zhannaklimanova committed Jun 16, 2023
2 parents ee9ab89 + 3f409e9 commit 943c792
Show file tree
Hide file tree
Showing 3 changed files with 83 additions and 1 deletion.
82 changes: 82 additions & 0 deletions .github/workflows/broken-link-checker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
name: Check for Broken Links
on: [push, pull_request]
jobs:
build_and_check:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v2

- name: Install Node.js
uses: actions/setup-node@v2
with:
node-version: 14

- name: Install dependencies
run: yarn install

- name: Build website
run: yarn build

- name: Setup Simple HTTP Server
run: |
nohup yarn start &
- name: Check HTTP Server status
run: sleep 5 && curl -I http://127.0.0.1:8080

- name: Install Broken Link Checker
run: npm install -g broken-link-checker

- name: Execute Link Checker and Show Broken Links
env:
TEMPORARY_WEBSITE_URL: "http://127.0.0.1:8080"
ACTUAL_WEBSITE_URL: "https://ddmal.music.mcgill.ca/Neon"
run: |
output=$(blc $TEMPORARY_WEBSITE_URL --filter-level=3 | \
grep -v -E '├───OK───|└───OK───' | \
awk '
BEGIN {
p=1;
buf=""
}
# The logic between the following two statements ensures lines started with "Getting links from:"
# and immediately followed by a line starting with "Finished!" and containing "0 broken" get removed
/^Getting links from:/ {
buf=$0;
next
}
/^Finished!.*0 broken\./ {
if (length(buf)>0) {
buf="";
next
}
}
{
if(length(buf)>0)
print buf;
if (NF > 0) # ensures only lines with non-zero fields are printed
print;
buf=""
}
# Printing an empty line after any single "Finished!" keyword to separate the outputs
/^Finished!/ {
print ""
}
' | sed "s|$TEMPORARY_WEBSITE_URL|$ACTUAL_WEBSITE_URL|g")
echo "$output"
# Fail the github actions only if there's a single HTTP 404 found
echo "$output" | grep -q 'HTTP_404' && flag=1
if [ "$flag" -eq "1" ]; then
echo "Broken links were found, exiting with an error."
exit 1
else
echo "No broken links were found (although there may be other HTTP errors - check above), exiting successfully."
exit 0
fi
Binary file modified assets/img/logos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion deployment/server/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@
<a href="http://ddmal.music.mcgill.ca/" target="_blank" class="ddmal"></a>
<a href="http://www.cirmmt.org" target="_blank" class="cirmmt"></a>
<a href="http://www.frqsc.gouv.qc.ca" target="_blank" class="frqsc"></a>
<a href="https://www.computecanada.ca/home/" target="_blank" class="computecanada"></a>
<a href="https://alliancecan.ca/en" target="_blank" class="alliancecan"></a>
<a href="https://www.westgrid.ca/" target="_blank" class="westgrid"></a>
</div>

Expand Down

0 comments on commit 943c792

Please sign in to comment.