chore: merge pull request #50 from threeal/docs-rec-version

Adjust Recommended Version
This commit is contained in:
Alfi Maulana 2023-06-30 13:55:20 +07:00 committed by GitHub
commit 699012010f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -54,7 +54,7 @@ jobs:
uses: actions/checkout@v3.5.3 uses: actions/checkout@v3.5.3
- name: Configure the project - name: Configure the project
uses: threeal/cmake-action@main uses: threeal/cmake-action@v1.2.0
- name: Build the project - name: Build the project
runs: cmake --build build runs: cmake --build build
@ -63,13 +63,13 @@ jobs:
runs: ctest --test-dir build runs: ctest --test-dir build
``` ```
> **Note**: You can replace `@main` with any version you prefer. See [this](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsuses). > **Note**: You can replace [`v1.2.0`](https://github.com/threeal/cmake-action/releases/tag/v1.2.0) with any version you prefer. See [this](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsuses).
#### Specify the Source and Build Directories #### Specify the Source and Build Directories
```yaml ```yaml
- name: Configure the project - name: Configure the project
uses: threeal/cmake-action@main uses: threeal/cmake-action@v1.2.0
with: with:
source-dir: submodules source-dir: submodules
build-dir: submodules/out build-dir: submodules/out
@ -79,7 +79,7 @@ jobs:
```yaml ```yaml
- name: Configure, build, and test the project - name: Configure, build, and test the project
uses: threeal/cmake-action@main uses: threeal/cmake-action@v1.2.0
with: with:
options: BUILD_TESTING=ON options: BUILD_TESTING=ON
run-build: true run-build: true
@ -90,7 +90,7 @@ jobs:
```yaml ```yaml
- name: Configure and build the project - name: Configure and build the project
uses: threeal/cmake-action@main uses: threeal/cmake-action@v1.2.0
with: with:
generator: Ninja generator: Ninja
c-compiler: clang c-compiler: clang