Check links for release notes #559
Merged
Conversation
This file contains hidden or 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
ffa8f9d to
ac5cf79
Compare
arnaucasau
approved these changes
Dec 29, 2023
Comment on lines
+144
to
+146
| # By default, only the non-API docs are checked. You can add any of these | ||
| # options to check API docs. | ||
| npm run check:links -- --current-apis --qiskit-release-notes |
There was a problem hiding this comment.
Nit: Mention the Qiskit release notes in the comment to avoid thinking they need each other to work, or maybe add a different one similar to the external links
There was a problem hiding this comment.
I'll see if this more clear in the follow up.
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
Part of Qiskit#495. -- This PR adds two arguments to `npm run check:links`, `--current-apis` and `--qiskit-release-notes`. In a follow up, we'll add `--historical-apis`. By default, we don't do any of these checks since it's pretty rare for a PR author to be changing those files and we want `npm run check` to be as fast as possible locally. CI will still check the whole thing, though. This makes the script around 2x faster: ``` npm run check:links 4.04s user 0.32s system 156% cpu 2.797 total npm run check:links -- --current-apis --qiskit-release-notes 8.66s user 0.99s system 134% cpu 7.182 total ``` -- To fix the actual broken links, I manually fixed problems in release notes up to 0.44. We are unlikely to regenerate these release notes, so manual fixes should be fine. I did not fix 0.45, though, since we will continue to regenerate those release notes per Qiskit#537. We will need to fix the underlying problem in the API docs, or in our API generation script.
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.
Part of #495.
--
This PR adds two arguments to
npm run check:links,--current-apisand--qiskit-release-notes. In a follow up, we'll add--historical-apis. By default, we don't do any of these checks since it's pretty rare for a PR author to be changing those files and we wantnpm run checkto be as fast as possible locally. CI will still check the whole thing, though.This makes the script around 2x faster:
--
To fix the actual broken links, I manually fixed problems in release notes up to 0.44. We are unlikely to regenerate these release notes, so manual fixes should be fine.
I did not fix 0.45, though, since we will continue to regenerate those release notes per #537. We will need to fix the underlying problem in the API docs, or in our API generation script.