Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: automatically add review comments to prettier infractions #2680

Merged
merged 9 commits into from
Oct 3, 2023

Conversation

pepopowitz
Copy link
Collaborator

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 to main.

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

image

See #2664 for the prototype.

When should this change go live?

  • This change is not yet live and should not be merged until {ADD_DATE} (apply hold label or convert to draft PR)?
  • There is no urgency with this change.
  • This change or page is part of a marketing blog, conference talk, or something else on a schedule.
  • This functionality is already available but undocumented.
  • This is a bug fix or security concern.

PR Checklist

  • I have added changes to the relevant /versioned_docs directory, or they are not for an already released version.
  • I have added changes to the main /docs directory (aka /next/), or they are not for future versions.
  • My changes require an Engineering review, and I've assigned an engineering manager or tech lead as a reviewer, or my changes do not require an Engineering review.
  • My changes require a technical writer review, and I've assigned @christinaausley as a reviewer, or my changes do not require a technical writer review.

@pepopowitz pepopowitz added the component:docs Documentation improvements, including new or updated content label Oct 3, 2023
@pepopowitz pepopowitz requested a review from akeller October 3, 2023 19:11
@pepopowitz pepopowitz self-assigned this Oct 3, 2023
akeller
akeller previously approved these changes Oct 3, 2023
Base automatically changed from pepopowitz/1876-detect-crossover-links-pr to main October 3, 2023 20:32
@pepopowitz pepopowitz dismissed akeller’s stale review October 3, 2023 20:32

The base branch was changed.

@pepopowitz pepopowitz requested a review from akeller October 3, 2023 21:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation improvements, including new or updated content
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Auto-format commits that come through GitHub UI
2 participants