Skip to content

Commit e862d99

Browse files
committed
Update example usage
1 parent dd6f9de commit e862d99

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,26 @@ 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:
21-
runs-on: ${{ matrix.os }}
22+
format:
23+
runs-on: [ubuntu-latest, windows-latest]
2224
strategy:
2325
fail-fast: false
24-
matrix:
25-
os: [ubuntu-latest, windows-latest, ubuntu-24.04-arm]
2626

2727
steps:
28-
- uses: foxtran/setup-codee@v1
28+
- uses: actions/checkout@v4
29+
- uses: foxtran/setup-codee@v1
30+
31+
- name: Run Fortran formatter
32+
run: |
33+
codee format . --verbose
2934
30-
- run: |
31-
codee format --help
35+
- name: Check for uncommitted changes
36+
run: |
37+
git diff --exit-code
3238
```
3339
3440

0 commit comments

Comments
 (0)