Workflow to check links in markdown files #17
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Link Checker for Sphinx Documentation | |
| # Trigger the workflow on push to main branch or pull request to main branch | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| types: [opened, reopened, synchronize] | |
| jobs: | |
| link-check: | |
| runs-on: ubuntu-latest | |
| steps: | |
| # Checkout the repository | |
| - name: Checkout repository | |
| uses: actions/checkout@v3 | |
| # Set up Python | |
| - name: Set up Python 3.x | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.x' | |
| # Install dependencies | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip #upgrading pip | |
| pip install -r docs/requirements.txt #installing the required packages from repo docs/requirements.txt | |
| echo "Dependencies installed." | |
| # Run Sphinx linkcheck to check for broken URLs | |
| - name: Run Sphinx linkcheck | |
| run: | | |
| cd docs | |
| sphinx-build -b linkcheck source _build/linkcheck > /dev/null 2>&1 || true # Suppress full output of the sphinx-build -b linkcheck source _build/linkcheck command and redirect the output to /dev/null | |
| # Extract broken links | |
| grep "broken" _build/linkcheck/output.txt > broken_links.txt # Using Grep Extract broken links from the output.txt file and save them to broken_links.txt | |
| grep "Not Found for url" _build/linkcheck/output.txt > not_found_links.txt # Using Grep Extract 'Not Found for url' links from the output.txt file and save them to not_found_links.txt | |
| # -s flag checks if the file is not empty | |
| # Display broken links if found | |
| if [ -s broken_links.txt ]; then | |
| echo "===============================" | |
| echo "Broken links found:" | |
| echo "===============================" | |
| cat broken_links.txt | |
| fi | |
| # Display 'Not Found for url' links if found | |
| if [ -s not_found_links.txt ]; then | |
| echo "===============================" | |
| echo "Not Found for url:" | |
| echo "===============================" | |
| cat not_found_links.txt | |
| fi | |
| # Exit with error if any broken or not found links exist | |
| if [ -s broken_links.txt ] || [ -s not_found_links.txt ]; then | |
| echo "!!!!!!!!!!!!!!!!!!!!!!!!" | |
| echo "Broken links found." | |
| echo "!!!!!!!!!!!!!!!!!!!!!!!!" | |
| exit 1 | |
| else | |
| echo "#########################" | |
| echo "No broken links found." | |
| echo "#########################" | |
| fi |