refactor(cmake-workflow): split setup step

Author: alandefreitas

.github/workflows/ci.yml

@@ -109,6 +109,8 @@ jobs:
       - name: CMake Workflow
         uses: ./cmake-workflow
         with:
+          cmake-version: '>=3.8'
+          cmake-min-version: ${{ matrix.container && '3.8' }}
           source-dir: tests
           generator: ${{ matrix.generator }}
           toolchain: ${{ steps.package-install.outputs.vcpkg-toolchain }}
@@ -119,7 +121,6 @@ jobs:
           cxx: ${{ matrix.cxx }}
           cxxflags: ${{ matrix.cxxflags }}
           cc: ${{ matrix.cc }}
-          cmake-min-version: 3.15
           extra-args: -D BOOST_SRC_DIR=$GITHUB_WORKSPACE/boost-root
           ref-source-dir: .
 

README.adoc

@@ -139,45 +139,67 @@ steps:
 - name: CMake Workflow
   uses: alandefreitas/cpp-actions/cmake-workflow@master
   with:
+    cmake-version: '>=3.8'
     source-dir: tests
     toolchain: ${{ steps.package-install.outputs.vcpkg-toolchain }}
     run-tests: 'true'
     install-prefix: $GITHUB_WORKSPACE/.local
     cxxstd: 17,20
     cxx: g++-11
     cc: gcc-11
-    cmake-min-version: 3.15
     extra-args: -D BOOST_SRC_DIR=$GITHUB_WORKSPACE/boost-root
     ref-source-dir: .
 ----
 
-Example 2 (`build-type`, `generator`):
+Example 2 (`cmake-min-version`):
 
 [source,yml]
 ----
 steps:
 - name: CMake Workflow
   uses: alandefreitas/cpp-actions/cmake-workflow@master
   with:
+    cmake-version: '>=3.8'
+    cmake-min-version: '3.8'
+    source-dir: tests
+    toolchain: ${{ steps.package-install.outputs.vcpkg-toolchain }}
+    run-tests: 'true'
+    install-prefix: $GITHUB_WORKSPACE/.local
+    cxxstd: '11'
+    cxx: g++-4.8
+    cc: gcc-4.8
+    extra-args: -D BOOST_SRC_DIR=$GITHUB_WORKSPACE/boost-root
+    ref-source-dir: .
+----
+
+Example 3 (`build-type`, `generator`):
+
+[source,yml]
+----
+steps:
+- name: CMake Workflow
+  uses: alandefreitas/cpp-actions/cmake-workflow@master
+  with:
+    cmake-version: '>=3.8'
     source-dir: tests
     generator: Unix Makefiles
     toolchain: ${{ steps.package-install.outputs.vcpkg-toolchain }}
     build-type: Debug
     run-tests: 'true'
     install-prefix: $GITHUB_WORKSPACE/.local
-    cmake-min-version: 3.15
     extra-args: -D BOOST_SRC_DIR=$GITHUB_WORKSPACE/boost-root
     ref-source-dir: .
 ----
 
-Example 3 (`cxxflags`):
+Example 4 (`cxxflags`):
 
 [source,yml]
 ----
 steps:
 - name: CMake Workflow
   uses: alandefreitas/cpp-actions/cmake-workflow@master
   with:
+    cmake-version: '>=3.8'
     source-dir: tests
     toolchain: ${{ steps.package-install.outputs.vcpkg-toolchain }}
     run-tests: 'true'
@@ -186,7 +208,6 @@ steps:
     cxx: clang++-12
     cxxflags: -stdlib=libc++
     cc: clang-12
-    cmake-min-version: 3.15
     extra-args: -D BOOST_SRC_DIR=$GITHUB_WORKSPACE/boost-root
     ref-source-dir: .
 ----
@@ -195,10 +216,31 @@ steps:
 
 |===
 |Parameter |Description |Default
+|`cmake-exec` |The cmake executable. |`cmake`
+|`cmake-version` |A semver range string with the cmake versions supported by this workflow. 
+
+ If the existing version in the environment does not satisfy this requirement, the action attempts
+to install or update CMake using cmake-min-version.
+
+If this input is undefined, the version ">= cmake-min-version" is considered. 
+
+This should usually match the `cmake_minimum_required` defined in your CMakeLists.txt file.
+. |
+|`cmake-min-version` |Set the minimum cmake version for this workflow when the cmake-version requirement is not satisfied. 
+
+If the existing version in the environment does not satisfy this cmake-version requirement, 
+the action attempts to install or update CMake using this cmake-min-version.
+
+If cmake-version is not set, this option overrides the `cmake-version` input as `>= cmake-min-version`.
+
+If cmake-min-version is not defined, the action attempts to extract the cmake-min-version
+from CMakeLists.txt.
+
+If a minimum version cannot be found in CMakeLists.txt, the lastest CMake version is considered 
+the minimum version. 
+. |
 |`source-dir` |Directory for the source files. |`.`
 |`build-dir` |Directory for the binaries relative to the source directory. |`build`
-|`cmake-exec` |The cmake executable. |`cmake`
-|`cmake-min-version` |The minimum cmake version for this workflow. If the existing version is below that, the action attempts to update CMake. |`3.5`
 |`cc` |Path to C compiler. |
 |`cxx` |Path to C++ compiler. |
 |`cxxstd` |List of standards with which cmake will build and test the program. |
@@ -208,14 +250,14 @@ steps:
 |`build-type` |Build type. |`Release`
 |`build-target` |Targets to build instead of the default target. |
 |`install-prefix` |Path where the library should be installed. |`.local/usr`
+|`extra-args` |Extra arguments to cmake configure command. |
 |`run-tests` |Whether we should run tests. |`true`
 |`install` |Whether we should install the library. 
 
 The library is only installed once in the `install-prefix`.
 
 The latest std version described in `cxxstd` is used for the installed version.
 . |`true`
-|`extra-args` |Extra arguments to cmake configure command. |
 |`create-annotations` |Create github annotations on errors. |`true`
 |`ref-source-dir` |A reference source directory for annotations. Any annotation filename will be relative to this directory.
 
@@ -225,7 +267,6 @@ we need to make annotations relative to some other directory.
 In most cases, the default option should be enough.
 . |`.`
 |`trace-commands` |Trace commands executed by the workflow. |`false`
-|`cpack-generators` |Run cpack with the specified generators after the install step. |
 |===
 
 === Boost Clone [[boost-clone]]