Skip to content

[CLIENT-4306] Increase Sphinx linkcheck retry count to 4 to prevent false positives #989

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
juliannguyen4 wants to merge 4 commits into
base: dev
Choose a base branch
from
Draft

[CLIENT-4306] Increase Sphinx linkcheck retry count to 4 to prevent false positives #989

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4c7f23d
Increase linkcheck's retry count to 4
juliannguyen4 Mar 11, 2026
e228063
Run with double verbosity to make easier to debug
juliannguyen4 Mar 11, 2026
569aef6
Since bug happens on Github Actions, get bug report from there.
juliannguyen4 Mar 11, 2026
5de93f0
Forgot to override success() condition
juliannguyen4 Mar 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion .github/workflows/doc-tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ jobs:
builder-command:
- 'spelling . spelling -W --keep-going'
# -vv is too verbose and makes it hard to read logs
- 'linkcheck -v . links'
- 'linkcheck -vv . links'
steps:
- name: Harden the runner (Audit all outbound calls)
uses: step-security/harden-runner@a90bcbc6539c36a85cdfeb73f7e2f433735f215b # v2.15.0
Expand All @@ -52,5 +52,9 @@ jobs:
# TODO: find way to split up dependencies
run: python -m pip install -r doc/requirements.txt
- name: Run builder
id: builder
run: sphinx-build -b ${{ matrix.builder-command }}
working-directory: doc
- if: ${{ !cancelled() && steps.builder.outcome == 'failure' }}
run: sphinx-build --bug-report
working-directory: doc
3 changes: 2 additions & 1 deletion doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,4 +269,5 @@ def __getattr__(cls, name):
"https://docs.aerospike.com/server/guide/security/index.html"
]

linkcheck_timeout = 120
linkcheck_timeout = 30
linkcheck_retries = 4
Loading