[INFRA] Fix linkchecker #982
Merged
Conversation
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
|
I also tend to start ignoring doi.org links here, see bids-standard/bids-website#223 |
effigies
reviewed
Jan 20, 2022
.circleci/config.yml
Outdated
Comment on lines
56
to
57
| --ignore-url 'https://bids-specification.readthedocs.io/en/stable/04-modality-specific-files/10-microscopy.html' \ | ||
| --ignore-url 'https://bids-specification.readthedocs.io/en/stable/99-appendices/14-glossary.html' \ |
There was a problem hiding this comment.
Why shouldn't we just ignore all stable links?
Suggested change
| --ignore-url 'https://bids-specification.readthedocs.io/en/stable/04-modality-specific-files/10-microscopy.html' \ | |
| --ignore-url 'https://bids-specification.readthedocs.io/en/stable/99-appendices/14-glossary.html' \ | |
| --ignore-url 'https://bids-specification.readthedocs.io/en/stable/.*' \ |
There was a problem hiding this comment.
Can't think of a reason.
There was a problem hiding this comment.
Just to be clear: this means that none of the internal links will be checked then. Am I understanding this correctly?
There was a problem hiding this comment.
I think that this will only impact the links in the HTML headers, because the internal spec links (in the text) are looking like this:
<p>Additional fields can include external behavioral measures relevant to the
scan.
For example vigilance questionnaire score administered after a resting
state scan.
All such included additional fields SHOULD be documented in an accompanying
<code>_scans.json</code> file that describes these fields in detail
(see <a href="02-common-principles.html#tabular-files">Tabular files</a>).</p>
<p>Example <code>_scans.tsv</code>:</p>
<div class="highlight"><pre><span></span><code>filename acq_time
func/sub-control01_task-nback_bold.nii.gz 1877-06-15T13:45:30
func/sub-control01_task-motor_bold.nii.gz 1877-06-15T13:55:33that is: They don't match the full form https://bids-specification.readthedocs.io/en/stable/.*
There was a problem hiding this comment.
ah OK
thanks for the clarification
Co-authored-by: Chris Markiewicz <effigies@gmail.com>
effigies
approved these changes
Jan 20, 2022
effigies
added
the
exclude-from-changelog
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The problem with our linkchecker failing for weeks is the following:
bids-specification/mkdocs.yml
Line 2 in 4bf68b9
This is how it looks:
Whenever we add a new HTML page to the spec, like the glossary, or microscopy - but haven't done a release yet, linkchecker will fail because those HTML pages are not available in the stable (canonical) URL.
I think we can fix this by temporarily adding these files to the ignore list of the linkchecker, and then "cleaning up" that ignore list at release time.
WDYT?
EDIT: cc @tsalo who figured this out in the first place