Pages render check only runs on changed files #913
Merged
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
This reverts commit 3821197.
Eric-Arellano
changed the title
Eric-Arellano
commented
Feb 27, 2024
frankharkins
approved these changes
Feb 28, 2024
| run: npm run check-pages-render | ||
| if: steps.changed-docs-files.outputs.any_changed == 'true' | ||
| run: | | ||
| echo "${{ steps.changed-docs-files.outputs.all_changed_files }}" > changed.txt |
github-merge-queue bot
pushed a commit
that referenced
this pull request
Feb 28, 2024
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.
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
Closes Qiskit#886. As explained there, it's safe to only run this check on changed files because whether a page renders is independent from all the other pages. We use a weekly cron job, though, to check all pages. That reduces our risk from things like the docs preview Docker image changing on us and resulting in some pages now failing to render. -- This PR also stops checking external links in API docs builds and instead moves the check to the new weekly cron job. Relates to Qiskit#876. Per Qiskit#372, it's annoying to check external links in CI because it can be flaky (Qiskit#823).
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
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.
Closes #886. As explained there, it's safe to only run this check on changed files because whether a page renders is independent from all the other pages.
We use a weekly cron job, though, to check all pages. That reduces our risk from things like the docs preview Docker image changing on us and resulting in some pages now failing to render.
--
This PR also stops checking external links in API docs builds and instead moves the check to the new weekly cron job. Relates to #876.
Per #372, it's annoying to check external links in CI because it can be flaky (#823).