API changes now check that API pages render #792
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 2aa3ae3.
Eric-Arellano
commented
Feb 12, 2024
| on: | ||
| workflow_dispatch: | ||
| schedule: | ||
| - cron: "0 0 * * *" # Every day at midnight UTC | ||
| - cron: "0 0 * * 0,2,4" # Every Sunday, Tuesday, and Thursday at midnight UTC |
There was a problem hiding this comment.
Switched to 3 times a week to waste fewer resources. Most people aren't checking on Friday night and Saturday what happened, for example.
arnaucasau
approved these changes
Feb 12, 2024
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
Closes Qiskit#773. Now that we've fixed all historical pages not rendering, it's important we don't regress. The check is much faster than it used to be, so we decided it's worth the CI slowdown. More broadly, it's become clear that there are two types of changes we make: a) API docs, and b) non-API docs. They are very different workflows, since API docs are 100% automated. Our CI should better reflect this reality, whereas before for example `main.yml` would check relative links for API docs. To speed up the API CI job, we split it up into two parallel jobs. Once we start working more with translations, we'll want to consider a `translations.yml` workflow. Those are also fairly isolated in comparison to API docs and non-API docs.
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 #773.
Now that we've fixed all historical pages not rendering, it's important we don't regress. The check is much faster than it used to be, so we decided it's worth the CI slowdown.
More broadly, it's become clear that there are two types of changes we make: a) API docs, and b) non-API docs. They are very different workflows, since API docs are 100% automated. Our CI should better reflect this reality, whereas before for example
main.ymlwould check relative links for API docs.To speed up the API CI job, we split it up into two parallel jobs.
Once we start working more with translations, we'll want to consider a
translations.ymlworkflow. Those are also fairly isolated in comparison to API docs and non-API docs.