feat: automatically add review comments to prettier infractions #2680
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.
Note that the
base
for this PR is the branch from #2675. When that one merges, it will reset any approvals, and auto-set the base tomain
.Resolves #1104.
Blocked by #2675, as it depends on the workflow introduced in that PR. My urgency for #2675 is higher than this one, because that one is more likely to catch issues before our release next week.
Description
This PR moves our prettier check from the build-docs workflow to the check-format workflow, and modifies it to add review comments for all violations. This enables us to more easily format changes in PRs that are submitted through the GitHub UI with formatting issues. (We can commit the fixes through the GitHub UI, instead of someone having to pull the change locally, formatting it, and pushing it back up.)
What it looks when there is a prettier infraction
See #2664 for the prototype.
When should this change go live?
hold
label or convert to draft PR)?PR Checklist
/versioned_docs
directory, or they are not for an already released version./docs
directory (aka/next/
), or they are not for future versions.