Skip to content

Update README to reference the correct options #86

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
shahmishal merged 1 commit into from
Feb 1, 2025
Merged

Update README to reference the correct options #86

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
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ jobs:
### Testing

To enable pull request testing for all supported Swift versions (5.8, 5.9, 5.10,
6.0, and nightly) on Linux, add the following code example in
6.0, and nightly) on Linux and Windows, add the following code example in
`.github/workflows/pull_request.yml`:

```yaml
Expand All @@ -58,10 +58,11 @@ jobs:
```

If your package only supports newer compiler versions, you can exclude older
versions by using the `exclude_swift_versions` workflow input:
versions by using the `*_exclude_swift_versions` workflow input:

```yaml
exclude_swift_versions: "[{\"swift_version\": \"5.8\"}]"
linux_exclude_swift_versions: "[{\"swift_version\": \"5.8\"}, {\"swift_version\": \"5.9\"}]"
windows_exclude_swift_versions: "[{\"swift_version\": \"5.9\"}]"
```

Additionally, if your package requires additional installed packages, you can
Expand All @@ -72,7 +73,7 @@ use the `pre_build_command`. For example, to install a package called
pre_build_command: "which example || (apt update -q && apt install -yq example"
```

macOS and Windows platform support will be available soon.
macOS platform support will be available soon.

## Running workflows locally

Expand Down