Merge f59b2b0 into 06be14d

CatChen · web-flow · commit 91f8d4ee166e · 2026-02-26T21:44:04.000-08:00
diff --git a/README.md b/README.md
@@ -5,8 +5,9 @@
 
 Do you check in dependency packages or build artefacts? If yes this GitHub Action helps you ensure they are not out-of-sync. Examples:
 
-1. Say we set up to [run Yarn offline](https://classic.yarnpkg.com/blog/2016/11/24/offline-mirror/) and we check in Yarn offline mirror. We want to make sure the offline mirror is in sync with the dependencies declared in the `package.json`. We can set up a GitHub Workflow to run `yarn install` and then use this Action to check if the offline mirror is changed.
-2. Say we generate TypeScript type definitions from [JSON Schemas](https://json-schema.org/). The generated TypeScript files are part of the codebase. We want to make sure people remember to regenerate these files when they modify any JSON Schema. We can use a GitHub Workflow to run the code generation and then use this GitHub Action to check if the files are changed. If they are changed this Action can commit the changes and add them to the Pull Request.
+1. Say we run [Prettier](https://prettier.io/) or [`oxfmt`](https://github.com/oxc-project/oxc/tree/main/crates/oxfmt) in CI and require developers to commit any formatting updates. We can run the formatter and then use this Action to fail the workflow, request changes, or auto-commit the formatting diff when files are out of sync.
+2. Say we set up to [run Yarn offline](https://classic.yarnpkg.com/blog/2016/11/24/offline-mirror/) and we check in Yarn offline mirror. We want to make sure the offline mirror is in sync with the dependencies declared in the `package.json`. We can set up a GitHub Workflow to run `yarn install` and then use this Action to check if the offline mirror is changed.
+3. Say we generate TypeScript type definitions from [JSON Schemas](https://json-schema.org/). The generated TypeScript files are part of the codebase. We want to make sure people remember to regenerate these files when they modify any JSON Schema. We can use a GitHub Workflow to run the code generation and then use this GitHub Action to check if the files are changed. If they are changed this Action can commit the changes and add them to the Pull Request.
 
 ## Usage
 
@@ -28,8 +29,8 @@ jobs:
 
       - name: Build
         run: |
-          # replace the following line with the real build script
-          touch some-build-artefact-newly-generated-in-the-build-process
+          yarn prettier -w .
+          yarn graphql-codegen --config codegen.ts
 
       - uses: CatChen/check-git-status-action@v2
         with:
