This repository has been archived by the owner on Feb 22, 2023. It is now read-only.
Use environment variable to determine whether to filter dead links by default; fix flaky tests #1043
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes
Fixes #1041 by @AetherUnbound
Description
The cause of the test failure described in the issue is the dead link filtering. Luckily, for basically all tests and local applications, we do not need to filter dead links by default. Enabling the default to be modified by an environment variable is the quickest solution for this that allows us to clean up tests that were explicitly disabling the dead link filtering, as a bonus.
The default in
settings.py
is True, which matches the original setting (before the variable existed, before this PR), so there will not need to be additional changes to the deployment configuration to keep the behaviour the same in staging and production.Testing Instructions
Run the tests locally and confirm they run. Also confirm they pass in CI.
Checklist
Update index.md
).main
) or a parent feature branch.Developer Certificate of Origin
Developer Certificate of Origin