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

Re-add Prettier GitHub workflow #9163 #9255

Merged
merged 14 commits into from
Oct 24, 2024
Merged

Conversation

rachelwhitton
Copy link
Member

This reverts commit eb86890.

Fixes #9082

Summary

per #9163 (comment) and #9163 (comment):

  • Adds/updates ESLint. This was added as part of the initial implementation which has been removed. ESLint was left because we'll probably use it again in the future.
  • Adds a new npm run lint script in package.json
  • Updates the README.md to note how to run ESLint locally or fix all style issues with Prettier (using the existing npm run format command)
  • Updates the Prettier config to use JS-based configuration and splits the difference between the old/existing config and the new config in 4ba6420
  • Adds a new Prettier GitHub action to run the linter when any *.js file in src/ is affected by a pull request and only on the changed files.
    • Prettier-formatted files affected by this are then committed back to the repository by the robot and a comment is left in the PR that files were changed (see test prettier gh action #9180 (comment) for an example)

@rachelwhitton rachelwhitton requested a review from a team as a code owner October 14, 2024 21:36
@wiz-inc-b08cf2810f
Copy link

wiz-inc-b08cf2810f bot commented Oct 14, 2024

Wiz Scan Summary

Scan Module Critical High Medium Low Info Total
IaC Misconfigurations 0 0 0 0 0 0
Vulnerabilities 0 0 0 0 0 0
Sensitive Data 0 0 0 0 0 0
Secrets 0 0 0 0 0 0
Total 0 0 0 0 0 0

View scan details in Wiz

To detect these findings earlier in the dev lifecycle, try using Wiz Code VS Code Extension.

@stevector
Copy link
Contributor

I expect this PR will be mergable soon since I have drastically reduced the amount of change. #9163 updated prettier and add a few ESLint related packages. It also updated thousands of lines of package-lock.json.

In this PR went back to the package.json and package-lock.json of main and then ran npm install "prettier@^3.0.0" --save-exact.

Copy link

⚡ Deployed with Pantheon Decoupled

This build was successfully deployed with Pantheon. You can track the build logs here.

👀 Preview: https://pr-9255-documentation.appa.pantheon.site
🛠️ Manage in Pantheon: https://dashboard.pantheon.io/site/2b30153f-e8b1-4427-b076-6109e704ba5d/overview

@stevector
Copy link
Contributor

And it built successfully! @jazzsequence @rachelwhitton can you review?

@rachelwhitton rachelwhitton added the Site - CI Continuous Integration work specific to the docs repo/site itself label Oct 16, 2024
Copy link
Contributor

@jazzsequence jazzsequence left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@stevector stevector assigned jazzsequence and unassigned stevector Oct 21, 2024
@stevector
Copy link
Contributor

@jazzsequence Can you review/merge this PR?

Copy link

⚡ Deployed with Pantheon Decoupled

This build was successfully deployed with Pantheon. You can track the build logs here.

👀 Preview: https://pr-9255-documentation.appa.pantheon.site
🛠️ Manage in Pantheon: https://dashboard.pantheon.io/site/2b30153f-e8b1-4427-b076-6109e704ba5d/overview

@jazzsequence jazzsequence merged commit 62e5791 into main Oct 24, 2024
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Site - CI Continuous Integration work specific to the docs repo/site itself
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update and automate the running of Prettier
3 participants