-
Notifications
You must be signed in to change notification settings - Fork 86
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.
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
Link checker: Qiskit legacy release notes in a single FileBatch #881
Link checker: Qiskit legacy release notes in a single FileBatch #881
Conversation
Thanks for contributing to Qiskit documentation! Before your PR can be merged, it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. Thanks! 🙌 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for diving further deeper into the complexity of this all 😅
scripts/commands/checkLinks.ts
Outdated
|
||
return await FileBatch.fromGlobs( | ||
toCheck, | ||
[`docs/api/qiskit/0.45/*`], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this pass for current code? I think you will want to move the code you currently have marked as TODO to instead apply here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, good catch! I have added it there and I will remove it in my other PR 👍
|
||
return await FileBatch.fromGlobs( | ||
toCheck, | ||
// Temporary - remove after https://github.com/Qiskit/documentation/pull/865 is merged |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you can remove this from where you had it before?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I was double checking everything. The only link we need to load is docs/api/qiskit/release-notes/index.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🙇
PR description is out of date btw |
Fixes a bug in #881. It handled `--qiskit-release-notes` correctly, but it incorrectly would skip `--historical-apis` for Qiskit versions before 0.45. This also loads fewer files for the migration guides.
…it#881) The legacy release notes of qiskit were generated from qiskit 0.45 and we need to check them loading those docs. This PR groups together all the legacy release notes in a FileBatch to avoid loading the same docs multiple times.
Fixes a bug in Qiskit#881. It handled `--qiskit-release-notes` correctly, but it incorrectly would skip `--historical-apis` for Qiskit versions before 0.45. This also loads fewer files for the migration guides.
The legacy release notes of qiskit were generated from qiskit 0.45 and we need to check them loading those docs. This PR groups together all the legacy release notes in a FileBatch to avoid loading the same docs multiple times.