ci(actions): build documentation when a PR is opened #43
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
After the recent deployment failure, checking to make sure documentation at least builds if any file under `docs/` is built is worth the time we run the task for. Currently using the builtin `paths` argument, but might switch to the skip-duplicate-actions workflow so that we can mark this workflow as required. Additionally, we're not doing anything with the output, we just want to make sure there aren't any build errors from vitepress at this time. If we move to starlight in the future, we'll most likely keep this same approach/workflow. Signed-off-by: Izzy Muerte <[email protected]>
I can always add a check that the first word is lower-case in the future. Signed-off-by: Izzy Muerte <[email protected]>
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.
After the recent deployment failure, checking to make sure documentation at least builds if any file under
docs/is built is worth the time we run the task for. Currently using the builtinpathsargument, but might switch to the skip-duplicate-actions workflow so that we can mark this workflow as required.Additionally, we're not doing anything with the output, we just want to make sure there aren't any build errors from vitepress at this time. If we move to starlight in the future, we'll most likely keep this same approach/workflow.