actions/cmake-action
1
0
Fork 0
mirror of https://github.com/threeal/cmake-action.git synced 2025-04-20 10:41:21 +00:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

docs: add documentation of shell action input

Browse Source
This commit is contained in:
Alfi Maulana 2023-07-04 19:24:49 +07:00
parent 0325477980
commit ca8ab2ff60
No known key found for this signature in database
GPG Key ID: 2242A64C2A8DF5A4
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -22,6 +22,7 @@ For more information, refer to [action.yml](./action.yml) and the [GitHub Action
| Name | Value Type | Description | | Name | Value Type | Description |
| --- | --- | --- | | --- | --- | --- |
| `shell` | String | The shell to be used to run the commands. It defaults to `pwsh` on Windows and `bash` on Linux and macOS. Refer to [this](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell) for more information on available shell options. |
| `source-dir` | Path | The source directory of the CMake project. It defaults to the current directory. | | `source-dir` | Path | The source directory of the CMake project. It defaults to the current directory. |
| `build-dir` | Path | The build directory of the CMake project. It defaults to the `build` directory inside the source directory. | | `build-dir` | Path | The build directory of the CMake project. It defaults to the `build` directory inside the source directory. |
| `generator` | String | The build system generator for the CMake project. It appends the CMake configuration arguments with `-G [val]`. | | `generator` | String | The build system generator for the CMake project. It appends the CMake configuration arguments with `-G [val]`. |