Skip to content

Commit c0a0cbb

Browse files
Update documentation to use quotes in YAML examples (#9)
* update readme to pass specific version as string * Update README.md
1 parent 350522e commit c0a0cbb

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ jobs:
1010
runs-on: macos-latest
1111
strategy:
1212
matrix:
13-
xcode-version: [10.3, 11, 11.2, 11.4.0, 11.4.1, ^11.4.0, latest, latest-stable]
13+
xcode-version: ['10.3', '11', '11.2', '11.4.0', '11.4.1', '^11.4.0', latest, latest-stable]
1414
fail-fast: false
1515
steps:
1616
- name: Checkout

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,13 @@ The list of all available versions can be found in [virtual-environments](https:
66
# Available parameters
77
| Argument | Description | Format |
88
|-------------------------|--------------------------|--------------------|
9-
| `xcode-version` | Specify the Xcode version to use | `latest`, `latest-stable` or any [semver](https://semver.org/) string |
9+
| `xcode-version` | Specify the Xcode version to use | - `latest` or<br> - `latest-stable` or<br> - [SemVer](https://semver.org/) string |
1010

11-
**Examples:** `latest`, `latest-stable`, `10`, `11.4`, `11.4.0`, `^11.4.0`
12-
**Note:**
11+
**Notes:**
1312
- `latest-stable` points to the latest stable version of Xcode
14-
- `latest` *includes* beta releases that GitHub actions has installed.
13+
- `latest` *includes* beta releases that GitHub actions has installed
14+
- SemVer examples: `10`, `11.4`, `12.0`, `11.7.0`, `^11.7.0` (find more examples in [SemVer cheatsheet](https://devhints.io/semver))
15+
- If sets a specific version, wraps it to single quotes in YAML like `'12.0'` to pass it as string because GitHub trimmes trailing `.0` from numbers
1516

1617
# Usage
1718
Set the latest stable Xcode version:
@@ -44,7 +45,7 @@ jobs:
4445
steps:
4546
- uses: maxim-lobanov/[email protected]
4647
with:
47-
xcode-version: 11.4
48+
xcode-version: '12.0'
4849
```
4950
# License
5051
The scripts and documentation in this project are released under the [MIT License](LICENSE)

0 commit comments

Comments
 (0)