Skip to content

Commit a81d1d4

Browse files
committed
Update example usage
1 parent dd6f9de commit a81d1d4

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,28 @@ Set up a Codee Formatter & Analyser on Linux and Windows runners.
1515

1616
## Usage
1717

18+
One can use this action in the following way to check that `codee format` does not change source code:
19+
1820
```yaml
1921
jobs:
20-
test:
22+
format:
2123
runs-on: ${{ matrix.os }}
2224
strategy:
2325
fail-fast: false
2426
matrix:
2527
os: [ubuntu-latest, windows-latest, ubuntu-24.04-arm]
2628

2729
steps:
28-
- uses: foxtran/setup-codee@v1
30+
- uses: actions/checkout@v4
31+
- uses: foxtran/setup-codee@v1
32+
33+
- name: Run Fortran formatter
34+
run: |
35+
codee format . --verbose
2936
30-
- run: |
31-
codee format --help
37+
- name: Check for uncommitted changes
38+
run: |
39+
git diff --exit-code
3240
```
3341
3442

0 commit comments

Comments
 (0)