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

Split internal and external link checker into separate programs #916

Merged
merged 3 commits into from
Feb 28, 2024

Conversation

Eric-Arellano
Copy link
Collaborator

Closes #876.

This split brings several improvements:

  1. Simpler internal link checker code.
  2. The external link checker now deduplicates links across all files, which avoids repeating requests.
  3. The external link checker logs its progress every 20 links.
  4. It's possible to check external links without checking internal links.

We run the external link checker in our weekly cron job over all files, other than translations and historical Qiskit versions. That change was added in #913.

Copy link
Collaborator

@arnaucasau arnaucasau left a comment

Choose a reason for hiding this comment

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

Awesome work with the link checker Eric! I left two non-blocking comments. Tested the link checker locally and works well!

README.md Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
const readArgs = (): Arguments => {
return yargs(hideBin(process.argv))
.version(false)
.command("$0 [globs..]", "")
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nice command! I didn't know this was possible, TIL

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Same. The search phrase was "yargs variadic positional arguments"

@Eric-Arellano Eric-Arellano added this pull request to the merge queue Feb 28, 2024
Merged via the queue into main with commit eb1912f Feb 28, 2024
2 checks passed
@Eric-Arellano Eric-Arellano deleted the EA/check-internal-vs-external branch February 28, 2024 20:00
frankharkins pushed a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
…it#916)

Closes Qiskit#876.

This split brings several improvements:

1. Simpler internal link checker code.
2. The external link checker now deduplicates links across all files,
which avoids repeating requests.
3. The external link checker logs its progress every 20 links.
4. It's possible to check external links without checking internal
links.

We run the external link checker in our weekly cron job over all files,
other than translations and historical Qiskit versions. That change was
added in Qiskit#913.
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.

Improve link checker API arguments to allow being more precise
2 participants