chore: add prettier auto-formatting github action #6087
+146
−123
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.
Proposed changes
I have implemented a new GitHub Actions workflow to automatically format our codebase using Prettier. This workflow runs automatically on every commit and pull request, with the exception of direct pushes to the develop branch.
The workflow utilizes Node.js 22 (as per the current LTS schedule: https://nodejs.org/en/about/previous-releases#release-schedule) and npm ci for dependable dependency installation. When triggered, it runs the Prettier formatter across the codebase, and if any formatting changes are detected, it automatically commits and pushes these changes with a standardized commit message: "chore: format code with Prettier".
This automation eliminates manual formatting tasks, reduces style-related discussions during code reviews, and maintains a consistent code style throughout our codebase. The workflow has been thoroughly tested across various scenarios including push events to feature branches and pull request events, confirming both its functionality and proper branch exclusion rules.
Issue(s)
None
Types of changes
Checklist