Skip to content

Commit da9af32

Browse files
committed
Clarify format for components parameter
1 parent c4c361a commit da9af32

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,39 @@ On Windows, we install an Express edition of the container. On Linux, a Docker c
88

99
### Inputs
1010

11-
* `components`: Specify the components you want to install. Can be `sqlengine` and `sqlcmd`.
11+
* `components`: Specify the components you want to install. Can be `sqlengine` and `sqlcmd`. The list of components needs be a comma-separated list like `sqlengine,sqlcmd`. [GitHub Actions does not support passing YAML lists to composite actions](https://github.com/actions/runner/issues/2238).
1212
* `force-encryption`: When you request to install `sqlengine`, you can set this input to `true` in order to encrypt all connections to the SQL server. The action will generate a self-signed certificate for that. Default is `false`.
1313
* `sa-password`: The sa password for the SQL instances. Default is `bHuZH81%cGC6`.
1414
* `version`: Version of the SQL server you want to install (2017, 2020 or 2022).
1515

16+
### Example
17+
18+
```yaml
19+
name: Continuous Integration
20+
21+
on:
22+
pull_request:
23+
push:
24+
schedule:
25+
- cron: "30 8 * * 1"
26+
27+
jobs:
28+
test:
29+
name: Tests
30+
runs-on: ubuntu-latest
31+
steps:
32+
- name: Checkout
33+
uses: actions/checkout@v4
34+
35+
- name: Setup MSSQL
36+
uses: andyundso/setup-mssql@v1
37+
with:
38+
components: sqlcmd,sqlengine
39+
force-encryption: true
40+
sa-password: "iamastrongpassword1234!"
41+
version: 2022
42+
```
43+
1644
## License
1745
1846
The scripts and documentation in this project are released under the MIT License.

0 commit comments

Comments
 (0)