Skip to content

Commit 7ef546c

Browse files
committed
Update readme
1 parent 3273319 commit 7ef546c

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Setup Swift
1+
# Setup Swift using Swiftly
22

33
<p>
44
<a href="https://github.com/features/actions">
@@ -15,17 +15,17 @@
1515
</a>
1616
</p>
1717

18-
[GitHub Action](https://github.com/features/actions) that will setup a [Swift](https://swift.org) environment with a specific version. Works on both Ubuntu and macOS runners.
18+
[GitHub Action](https://github.com/features/actions) that will setup a [Swift](https://swift.org) environment with a specific version using [Swiftly](https://github.com/swift-actions/swiftly). Works on both Ubuntu and macOS runners.
1919

2020
> [!IMPORTANT]
21-
> 3.0 is coming, powered by Swiftly 🚀 - follow progress on https://github.com/swift-actions/setup-swift/pull/710
21+
> Version 3 is currently in beta. Please report any issues you encounter. To use legacy version 2, use `@v2`.
2222
2323
## Usage
2424

2525
To run the action with the latest swift version available, simply add the action as a step in your workflow:
2626

2727
```yaml
28-
- uses: swift-actions/setup-swift@v2
28+
- uses: swift-actions/setup-swift@v3
2929
```
3030
3131
After the environment is configured you can run swift commands using the standard [`run`](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsrun) step:
@@ -41,7 +41,7 @@ A specific Swift version can be set using the `swift-version` input:
4141
```yaml
4242
- uses: swift-actions/setup-swift@v2
4343
with:
44-
swift-version: "5.1.0"
44+
swift-version: "5.1"
4545
- name: Get swift version
4646
run: swift --version # Swift 5.1.0
4747
```
@@ -63,17 +63,15 @@ steps:
6363
run: swift --version
6464
```
6565

66-
## Note about versions
67-
68-
This project uses strict semantic versioning to determine what version of Swift to configure. This differs slightly from the official convention used by Swift.
69-
70-
For example, Swift is available as version `5.1` but using this as value for `swift-version` will be interpreted as a version _range_ of `5.1.X` where `X` is the latest patch version available for that major and minor version.
66+
### Skip GPG signature verification
7167

72-
In other words specifying...
68+
If you are running on a runner that is not able to verify the GPG signature of the Swiftly package, you can skip the verification by setting the `skip-verify-signature` input to `true`.
7369

74-
- `"5.1.0"` will resolve to version `5.1`
75-
- `"5.1"` will resolve to latest patch version (aka `5.1.1`)
76-
- `"5"` will resolve to latest minor and patch version (aka `5.10`)
70+
```yaml
71+
- uses: swift-actions/setup-swift@v3
72+
with:
73+
skip-verify-signature: true
74+
```
7775

7876
### Caveats
7977

@@ -95,7 +93,7 @@ Not:
9593

9694
## Keeping the action up-to-date
9795

98-
You have two options for keeping this action up-to-date: either you define a specific version (like `v2.0.1`) or use the major version tag (like `v2`).
96+
You have two options for keeping this action up-to-date: either you define a specific version (like `v3.0.0`) or use the major version tag (like `v3`).
9997

10098
### Specific version
10199

0 commit comments

Comments
 (0)