Skip to content
This repository was archived by the owner on Jun 5, 2025. It is now read-only.

Add formatting step to CI #120

Merged
merged 1 commit into from
Nov 28, 2024
Merged

Add formatting step to CI #120

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
3 changes: 3 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ jobs:
- name: Run linting
run: make lint

- name: Run formatting
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we make the CI step explicitly fail if there are any changes afterwards?

if [[ -n "$(git status --porcelain)" ]]; then
          echo "Formatting produced changes. Please run 'make format' locally and commit the changes."
          exit 1
        fi

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it might actually fail is , should do a sys.exit code of 1, but I will check

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah no, it also formats it as well!

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So this will automatically format everything in the PR, unless that command fails, at which point CI will fail too.

run: make format

- name: Run tests
run: make test

Expand Down