Skip to content

Commit

Permalink
Update broken-linkcheck.yml
Browse files Browse the repository at this point in the history
#45409
A Github Action to run the Sphinx linkcheck monthly to check link errors. If errors are found, the GIthub Action creates a new issue, (and delete the old one) reporting all the errors, and label as Docs and Good First Issue
  • Loading branch information
ggold7046 authored Dec 3, 2023
1 parent 7c6d26f commit 81afa77
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion .github/workflows/broken-linkcheck.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,31 @@ jobs:
set -o pipefail
python make.py linkcheck | tee linkcheck.txt
- name: Create or Update Linkcheck Issue
if: github.event_name == 'schedule'
uses: dacbd/create-issue-action@main
with:
token: ${{ secrets.GITHUB_TOKEN }}
title: "Linkcheck Report - $(date +'%Y-%m-%d')"
labels: "Docs,Good First Issue,Linkcheck-Report"
body: |
### Linkcheck Report
This issue is automatically created or updated to report broken links found during the linkcheck process.
#### Summary:
- Number of Broken Links: X
- Date: $(date +"%Y-%m-%d")
#### Broken Links:
```
$(cat linkcheck.txt)
```
- name: Display broken links
if: failure()
if: failure() && github.event_name == 'schedule'
working-directory: ./doc
run: grep broken linkcheck.txt

0 comments on commit 81afa77

Please sign in to comment.