Skip to content

Commit f701675

Browse files
committed
build: Fix thinko, don't create CSV export from GitHub Actions
Commit 911d995 was misguided in the sense that `continue-on-error: true` of course causes the report file to be generated, but it also doesn't fail the build — and thus we wouldn't be getting a notification if we had dead links on the site. That's clearly not intentional, so drop CSV file generation from `.linkcheckerrc`, and also remove the artifact upload step from the `check` job. Instead, rely on the GitHub Actions job log to discern which links are dead. Getting a CSV file with a full report is still an option, when running from a local checkout: tox -e check -- -F csv Substitute other `-F` options like `html` or `xml` as needed. References: https://linkchecker.github.io/linkchecker/man/linkchecker.html#cmdoption-F https://linkchecker.github.io/linkchecker/man/linkchecker.html#output-types
1 parent ecb633f commit f701675

File tree

4 files changed

+3
-14
lines changed

4 files changed

+3
-14
lines changed

.github/workflows/check.yml

+1-7
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,9 @@ jobs:
1212
- name: Install Python dependencies
1313
run: |
1414
pip install tox
15-
- continue-on-error: true
16-
name: Test with tox
15+
- name: Test with tox
1716
run: |
1817
tox -e check
19-
- name: Upload link check report
20-
uses: actions/upload-artifact@v3
21-
with:
22-
name: check-${{ github.sha }}
23-
path: linkchecker-out.csv
2418
2519
name: 'Check links'
2620

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33
site/
44
.cache/
55
.tox/
6-
linkchecker-out.csv
6+
linkchecker-out.*

.linkcheckerrc

-5
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,3 @@ checkextern=1
1111
ignore =
1212
.*github\.com.*/edit/.*
1313
.*localhost.*
14-
15-
[output]
16-
# Create a CSV file containing all checked links, which can be
17-
# processed as a build artifact.
18-
fileoutput=csv

tox.ini

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ commands =
3939
[testenv:check]
4040
deps = linkchecker
4141
commands =
42-
linkchecker -f .linkcheckerrc https://docs.cleura.cloud/sitemap.xml
42+
linkchecker -f .linkcheckerrc {posargs} https://docs.cleura.cloud/sitemap.xml
4343

4444
[testenv:deploy-github]
4545
passenv =

0 commit comments

Comments
 (0)