Skip to content

Instantly share code, notes, and snippets.

@veracioux

veracioux/find_broken_urls.sh

Last active October 16, 2021 18:50
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save veracioux/14589d7aaf330c42dad653131daa2984 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save veracioux/14589d7aaf330c42dad653131daa2984 to your computer and use it in GitHub Desktop.
Download ZIP
Find broken links in a git project
Raw
find_broken_urls.sh
#!/usr/bin/env bash
# Should be called from the project root in order to search all subdirectories
# Reads each file in the working directory recursively and for each link runs
# curl to check the HTTP status code. If the status code starts with a 2 or a 3,
# then the link is OK, and BAD otherwise. If at least one BAD link is found, the
# script exits with an error code.
bad_count=0
files="$(git ls-tree --name-only -r HEAD)"
for file in $files; do
echo -e "\e[1;34mFile: $file\e[0m"
# For each url
for url in $(grep -Eo "https*://[A-Za-z0-9_~,;:\/\.\!\*\&\?\#\$\=\+@-]+" "$file")
do
# Read the HTTP header, then extract the second field (status code)
status_code=$(curl -Is "$url" | head -n 1 | awk '{print $2}')
# Print the status of the URL
if echo $status_code | grep -E '^(2.*.*|3.*.*)' > /dev/null; then
echo -ne "\e[1;32mOK \e[0m"
else
echo -ne "\e[0;31mBAD \e[0m"
let bad_count++
fi
# Print the URL
echo "$url"
done
done
echo "END."; echo "Bad URLs: $bad_count"
[ $bad_count == 0 ] || exit 1
@veracioux
Copy link
Author

veracioux commented Oct 16, 2021

License: Unlicense

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <https://unlicense.org>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment