Skip to content
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

Merged
merged 4 commits into from
Feb 23, 2024

Conversation

arnaucasau
Copy link
Collaborator

@arnaucasau arnaucasau commented Feb 23, 2024

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.

@qiskit-bot
Copy link
Contributor

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! 🙌

Copy link
Collaborator

@Eric-Arellano Eric-Arellano left a 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 Show resolved Hide resolved
scripts/commands/checkLinks.ts Outdated Show resolved Hide resolved

return await FileBatch.fromGlobs(
toCheck,
[`docs/api/qiskit/0.45/*`],
Copy link
Collaborator

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.

Copy link
Collaborator Author

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
Copy link
Collaborator

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?

Copy link
Collaborator Author

@arnaucasau arnaucasau Feb 23, 2024

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

scripts/lib/api/releaseNotes.ts Outdated Show resolved Hide resolved
Copy link
Collaborator

@Eric-Arellano Eric-Arellano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🙇

@Eric-Arellano
Copy link
Collaborator

PR description is out of date btw

@arnaucasau arnaucasau added this pull request to the merge queue Feb 23, 2024
Merged via the queue into Qiskit:main with commit 53d96eb Feb 23, 2024
2 checks passed
@arnaucasau arnaucasau deleted the AC/qiskit-historical-link-checker branch February 23, 2024 18:25
github-merge-queue bot pushed a commit that referenced this pull request Feb 26, 2024
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.
frankharkins pushed a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
…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.
frankharkins pushed a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants