Skip to content

Clarify parameter usage #16

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
merged 2 commits into from
Dec 9, 2024
Merged

Clarify parameter usage #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e3bc58a
Pass regular boolean to action
andyundso Dec 9, 2024
86e5533
Clarify format for `components` parameter
andyundso Dec 9, 2024
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
8 changes: 4 additions & 4 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ jobs:
strategy:
matrix:
force-encryption:
- "true"
- "false"
- true
- false
os:
# ignore ARM64 flavours
- ubuntu-20.04
Expand All @@ -29,11 +29,11 @@ jobs:
- 2019
- 2022
exclude:
- force-encryption: "true"
- force-encryption: true
os: ubuntu-24.04
version: 2017

- force-encryption: "false"
- force-encryption: false
os: ubuntu-24.04
version: 2017

Expand Down
30 changes: 29 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,39 @@ On Windows, we install an Express edition of the container. On Linux, a Docker c

### Inputs

* `components`: Specify the components you want to install. Can be `sqlengine` and `sqlcmd`.
* `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).
* `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`.
* `sa-password`: The sa password for the SQL instances. Default is `bHuZH81%cGC6`.
* `version`: Version of the SQL server you want to install (2017, 2020 or 2022).

### Example

```yaml
name: Continuous Integration

on:
pull_request:
push:
schedule:
- cron: "30 8 * * 1"

jobs:
test:
name: Tests
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup MSSQL
uses: andyundso/setup-mssql@v1
with:
components: sqlcmd,sqlengine
force-encryption: true
sa-password: "iamastrongpassword1234!"
version: 2022
```

## License

The scripts and documentation in this project are released under the MIT License.
Expand Down