What it does: Runs Prettier to reformat code and automatically commits the formatting changes back to the branch (useful for keeping style consistent).
name: Format with Prettier
on:
workflow_dispatch:
pull_request:
types: [opened, synchronize]
jobs:
prettier:
runs-on: ubuntu-latest
steps:
- name: Checkout (full)
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Use Node.js
uses: actions/setup-node@v4
with:
node-version: '18'
- name: Install dependencies
run: |
npm ci || npm install
npm install --no-save prettier
- name: Run Prettier (format)
run: npx prettier --write "**/*.{js,jsx,ts,tsx,json,md}"
- name: Commit formatted changes
uses: EndBug/add-and-commit@v9
with:
message: "chore: format code with Prettier"
add: "."
Description
What it does: Runs Prettier to reformat code and automatically commits the formatting changes back to the branch (useful for keeping style consistent).
Step-by-step
Add the file .github/workflows/format-prettier.yml.
Ensure your repo has a package.json (or npm ci will fallback to npm install).
Commit & push. Run the workflow manually from the Actions tab or open a PR.
If formatting changed files, the action commits them back to the branch. Inspect the PR to see the formatting commit.