Skip to content

Improve docs around running act for formatting #2965

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
glbrntt merged 1 commit into from
Nov 6, 2024
Merged

Improve docs around running act for formatting #2965

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
8 changes: 7 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,13 @@ SwiftNIO uses the [swift-format](https://github.com/swiftlang/swift-format) tool

If you want to apply the formatting to your local repo before you commit then you can either run [check-swift-format.sh](https://github.com/swiftlang/github-workflows/blob/main/.github/workflows/scripts/check-swift-format.sh) which will use your current toolchain, or to match the CI checks exactly you can use `act` (see [act section](#act)):
```
act --action-offline-mode --bind workflow_call -j format-check --input format_check_enabled=true
act --action-offline-mode --bind workflow_call --job soundness --input format_check_enabled=true
```

If you're using a machine with an ARM64 architecture (such as an Apple Silicon Mac) then
you'll also need to specify the container architecture:
```
act --container-architecture linux/amd64 --action-offline-mode --bind workflow_call --job soundness --input format_check_enabled=true
```

This will run the format checks, binding to your local checkout so the edits made are to your own source.
Expand Down