cmake-action/action.yml
Alfi Maulana 51d21ca665
docs: improve readme documentation (#386)
* docs(readme): improve project description

* docs(readme): remove unnecessary features section

* docs(readme): shift usage section and remove a paragraph

* docs(readme): improve available inputs and outputs section

* docs(readme): improve example usages section

* docs: update descriptions in `action.yml`
2024-08-05 10:57:10 +08:00

38 lines
1.2 KiB
YAML

name: CMake Action
description: Configure and build CMake projects
author: Alfi Maulana
branding:
color: gray-dark
icon: terminal
inputs:
source-dir:
description: The source directory of the CMake project
build-dir:
description: The build directory of the CMake project
generator:
description: The build system generator for the CMake project
c-compiler:
description: The preferred executable for compiling C language files
cxx-compiler:
description: The preferred executable for compiling C++ language files
c-flags:
description: Additional flags to pass when compiling C language files
cxx-flags:
description: Additional flags to pass when compiling C++ language files
options:
description: Additional options to pass during the CMake configuration
args:
description: Additional arguments to pass during the CMake configuration
run-build:
description: If enabled, builds the project using CMake
default: true
build-args:
description: Additional arguments to pass during the CMake build
outputs:
build-dir:
description: The build directory of the CMake project
value: ${{ steps.process-inputs.outputs.build-dir }}
runs:
using: node20
main: dist/index.js