Skip to content

Update example usage #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 15, 2025
Merged

Update example usage #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,28 @@ Set up a Codee Formatter & Analyser on Linux and Windows runners.

## Usage

One can use this action in the following way to check that `codee format` does not change source code:

```yaml
jobs:
test:
format:
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, windows-latest, ubuntu-24.04-arm]

steps:
- uses: foxtran/setup-codee@v1
- uses: actions/checkout@v4
- uses: foxtran/setup-codee@v1

- name: Run Fortran formatter
run: |
codee format . --verbose

- run: |
codee format --help
- name: Check for uncommitted changes
run: |
git diff --exit-code
```


Expand Down
Loading