docs: documentation updates #1055
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Formatter | |
on: | |
pull_request: | |
branches: | |
- develop | |
jobs: | |
prettier: | |
# This conditional prevents running the job on PRs from forks; won't | |
# have permissions to commit changes, so the job would fail if it ran. | |
# PRs from forks will instead rely on failing the fmt_check job in test.yml | |
if: github.event.pull_request.head.repo.full_name == github.repository | |
runs-on: ubuntu-latest | |
timeout-minutes: 5 | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
ref: ${{ github.event.pull_request.head.ref }} | |
- name: Install dependencies | |
run: npm ci | |
- uses: actions/setup-node@v4 | |
with: | |
node-version: 16 | |
cache: 'npm' | |
# Workflows are not allowed to edit workflows. As result, we need to prevent Prettier from formatting them. | |
- name: Prevent workflows from being formatted | |
run: echo ".github" >> .prettierignore && cat .prettierignore | |
- run: npm run fmt | |
# Prevent the prettierignore change from being committed. | |
- run: git checkout .prettierignore | |
- uses: stefanzweifel/git-auto-commit-action@8621497c8c39c72f3e2a999a26b4ca1b5058a842 # tag=v5 | |
with: | |
commit_message: ':robot: Automated formatting fixes' |