Link checker: Add a method to ignore non-API docs for objects.inv #2337
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
arnaucasau
commented
Nov 18, 2024
scripts/js/lib/links/ignores.ts
Outdated
Comment on lines
81
to
86
| // Latest version | ||
| `\/api\/qiskit-addon-[^\/]+\/${path}(\/.*|#.*|$)`, | ||
| // Historical versions | ||
| `\/api\/qiskit-addon-[^\/]+\/[0-9]+\.[0-9]\/${path}(\/.*|#.*|$)`, | ||
| // Dev version | ||
| `\/api\/qiskit-addon-[^\/]+\/dev\/${path}(\/.*|#.*|$)`, |
There was a problem hiding this comment.
These three regexes could be merged into one, but to avoid having a complex regex that could easily match undesirable links, I kept it separate.
scripts/js/lib/links/ignores.ts
Outdated
| `\/api\/qiskit-ibm-runtime\/0.15\/${path}(\/.*|#.*|$)`, | ||
| `\/api\/qiskit-ibm-runtime\/0.14\/${path}(\/.*|#.*|$)`, | ||
| ]) | ||
| .flat(); |
There was a problem hiding this comment.
I removed the flat call in this case given that it's not necessary anymore after combining the three regexes into one
scripts/js/lib/links/ignores.ts
Outdated
Comment on lines
105
to
107
| `\/api\/qiskit-ibm-runtime\/0.16\/${path}(\/.*|#.*|$)`, | ||
| `\/api\/qiskit-ibm-runtime\/0.15\/${path}(\/.*|#.*|$)`, | ||
| `\/api\/qiskit-ibm-runtime\/0.14\/${path}(\/.*|#.*|$)`, |
There was a problem hiding this comment.
I think you could use {14,15,16} to consolidate these into one rule?
There was a problem hiding this comment.
Yes, good idea! I used an or for the three versions 👍
Eric-Arellano
approved these changes
Nov 18, 2024
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.
This PR adds a new mechanism to ignore links where we can add a regex expression to ignore all the URLs that match it. It adds regexes for the non-API docs in the addons' and runtime's objects.inv.
Closes #2296