fix: render docs on PR after tests #470
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
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.
Got a bit of a dilemma. I would like to require status checks (like our test CI) to be up-do-date before merging.
And we also want the documentation to be up-to-date and rendered.
But
a) rendering the docs from gh actions creates a commit, making the commit on which the tests ran no longer the latest...
b) rendering the docs on main, triggered by a release, also doesn't work because we want changes to main to go through a PR:
Solution: all PR's are now drafts by default. Mark as "ready to review" to run tests. Convert back to draft when iterating (top right in the Reviewers box). Add the "docthis" label while it is still a draft to render docs.