Skip to content

Commit 14590e8

Browse files
authored
Add version instructions to readme
1 parent 2866186 commit 14590e8

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,13 @@ steps:
6262

6363
This project uses strict semantic versioning to determine what version of Swift to configure. This differs slightly from the official convention used by Swift.
6464

65-
For example, Swift is available as version `5.1` but this 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.
65+
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.
6666

6767

6868
In other words specifying...
6969
- `"5.1.0"` will resolve to version `5.1`
7070
- `"5.1"` will resolve to latest patch version (aka `5.1.1`)
71-
- `"5"` will resolve to latest minor and patch version (aka `5.5`)
71+
- `"5"` will resolve to latest minor and patch version (aka `5.7`)
7272

7373
### Caveats
7474

@@ -88,6 +88,18 @@ Not:
8888
swift-version: 5.0
8989
```
9090

91+
## Keeping the action up-to-date
92+
93+
You have two options for keeping this action up-to-date: either you define a specific version (like `v1.17.0`) or use the major version tag (like `v1`).
94+
95+
### Specific version
96+
97+
We recommend using the specific version tag together with [Dependabot](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates) to keep the action up-to-date. That way you will automatically get notifed when the action updates and you can read the changelog directly in the PR opened by dependabot.
98+
99+
### Major version tag
100+
101+
If you don't plan on keeping tabs on updates or don't want to use Dependabot but still would like to always use the latest version, you can use the main version tag.
102+
91103
## Legal
92104
Uses MIT license.
93105
The Swift logo is a trademark of Apple Inc.

0 commit comments

Comments
 (0)