-
-
Notifications
You must be signed in to change notification settings - Fork 1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(ci): separate linkcheck to standalone workflow
The linkcheck is less and less reliable in past weeks. It seems that some of the sites are broken often, it might be also caused by them blocking GitHub ranges as such probing might be visible on some of them. Separating the workflow allows us to execute it only on documentation changes (we still want to run regular documentation build on all pull requests to make it required).
- Loading branch information
Showing
2 changed files
with
59 additions
and
36 deletions.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# Copyright © Michal Čihař <michal@weblate.org> | ||
# | ||
# SPDX-License-Identifier: GPL-3.0-or-later | ||
|
||
name: Linkcheck | ||
|
||
on: | ||
push: | ||
paths: | ||
- docs/**.rst | ||
- docs/requirements.txt | ||
- .github/workflows/linkcheck.yml | ||
pull_request: | ||
paths: | ||
- docs/**.rst | ||
- docs/requirements.txt | ||
- .github/workflows/linkcheck.yml | ||
schedule: | ||
- cron: 30 5 * * * | ||
|
||
permissions: | ||
contents: read | ||
|
||
jobs: | ||
linkcheck: | ||
runs-on: ubuntu-24.04 | ||
name: Linkcheck | ||
|
||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Set up Python | ||
uses: actions/setup-python@v5 | ||
with: | ||
python-version: '3.12' | ||
- uses: astral-sh/setup-uv@v3 | ||
- name: Install apt dependencies | ||
run: | | ||
sudo apt update | ||
sudo apt install -y graphviz | ||
- name: Install Python dependencies | ||
run: | | ||
uv pip install --system -r docs/requirements.txt | ||
- name: Sphinx linkcheck | ||
run: | | ||
./ci/run-docs linkcheck | ||
- name: Sphinx linkcheck collect | ||
if: always() | ||
run: | | ||
echo "::add-matcher::.github/matchers/sphinx-linkcheck.json" | ||
echo "::add-matcher::.github/matchers/sphinx-linkcheck-warn.json" | ||
sed 's@^@docs/@' docs/_build/linkcheck/output.txt | ||
echo "::remove-matcher owner=sphinx::" | ||
echo "::remove-matcher owner=sphinx-warn::" | ||
- uses: actions/upload-artifact@v4.4.0 | ||
if: always() | ||
with: | ||
name: Linkcheck report | ||
path: docs/_build/linkcheck/output.txt |