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

chore: add prettier auto-formatting github action #6087

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

Rohit3523
Copy link
Contributor

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

  • Bugfix (non-breaking change which fixes an issue)
  • Improvement (non-breaking change which improves a current function)
  • New feature (non-breaking change which adds functionality)
  • Documentation update (if none of the other choices apply)

Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA
  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works (if applicable)
  • I have added necessary documentation (if applicable)
  • Any dependent changes have been merged and published in downstream modules

@Rohit3523 Rohit3523 closed this Jan 10, 2025
@Rohit3523 Rohit3523 reopened this Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant