chore: Add Prettier auto-formatting GitHub Action #5991
Conversation
|
Trying to figure out why action is failing here |
Depending on your own repo implementation, it may be failing because you don't have access to our org branches. |
Rohit3523
force-pushed
the
prettier-action
branch
from
4b3faf1
to
5013ac6
Compare
|
@diegolmello Done :) |
|
I was trying to run the action on RocketChat org and trying to push the formatted code in user branch which was getting blocked by github because of security reasons. So now if we do a commit, it will run a action on our own forked repo and make a commit on the same branch which will also reflect to PR. |
|
@diegolmello It is ready for the merge :) |
diegolmello
changed the title
| git config user.email "${{ github.actor }}@users.noreply.github.com" | ||
| git add . | ||
| git commit -m "chore: format code with Prettier" | ||
| git push origin HEAD:${{ github.head_ref || github.ref_name }} |
There was a problem hiding this comment.
Do you need github.head_ref?
There was a problem hiding this comment.
It fails in few condition, so i am using head_ref
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