Daily doc link check #52
This file contains hidden or 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: Daily doc link check | |
| on: | |
| schedule: | |
| - cron: '0 12 * * *' # 7 am EST every day | |
| workflow_dispatch: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| DocLinkCheck: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.13' | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -e . --group docs | |
| - name: Check external links | |
| run: sphinx-build -b linkcheck ./docs ./docs/_build/linkcheck | |
| NotifyOnFailure: | |
| runs-on: ubuntu-latest | |
| needs: [ DocLinkCheck ] | |
| if: ${{ always() && needs.DocLinkCheck.result == 'failure' }} | |
| permissions: {} | |
| steps: | |
| - uses: dawidd6/action-send-mail@v3 | |
| with: | |
| server_address: smtp.gmail.com | |
| server_port: 465 | |
| username: ${{ secrets.MAIL_USERNAME }} | |
| password: ${{ secrets.MAIL_PASSWORD }} | |
| subject: "CI Failure: nwb2bids Daily Doc Link Check" | |
| to: cody.c.baker.phd@gmail.com # Add more with comma separation (no spaces) | |
| from: nwb2bids | |
| body: "The daily doc link check workflow failed, please check status at https://github.com/con/nwb2bids/actions/workflows/daily_doc_link_check.yml" |