refactor(taskfile): Refactor taskfiles to separate log-surgeon and examples. (#142)

Author: davidlion

.github/workflows/build.yaml

@@ -50,15 +50,15 @@ jobs:
         run: "npm install -g @go-task/cli"
 
       - name: "Build and run unit tests"
-        run: "task test:${{matrix.build_type}}"
+        run: "task test:run-${{matrix.build_type}}"
 
       - name: "Print test log on failure"
         if: "failure()"
         run: "cat ./build/log-surgeon/Testing/Temporary/LastTest.log"
 
       - name: "Build and run examples"
         run: |-
-          task build:examples-${{matrix.build_type}}
+          task examples:build-${{matrix.build_type}}
           ./build/examples/${{matrix.build_type}}/buffer-parser ./examples/schema.txt README.md
           ./build/examples/${{matrix.build_type}}/reader-parser ./examples/schema.txt README.md
           ./build/examples/${{matrix.build_type}}/intersect-test

README.md

@@ -91,22 +91,22 @@ Requirements:
 * [GSL] >= 4.0.0
 * [Task] >= 3.38
 
-To build and install the project to `~/.local`:
+To build and install the project to `$HOME/.local`:
 
 ```shell
-task install:release INSTALL_PREFIX="~/.local"
+task log-surgeon:install-release INSTALL_PREFIX="$HOME/.local"
 ```
 
 Or to only build the project:
 
 ```shell
-task build:release
+task log-surgeon:build-release
 ```
 
 To build the debug version:
 
 ```shell
-task build:debug
+task log-surgeon:build-debug
 ```
 
 ## Examples
@@ -141,7 +141,7 @@ To host the site locally and view it:
 To build and run all unit tests:
 
 ```shell
-task test:debug
+task test:run-debug
 ```
 
 When generating targets, the CMake variable `BUILD_TESTING` is followed (unless overruled by setting

examples/README.md

@@ -14,7 +14,7 @@ First, ensure you've built and installed the library by following
 [these steps][2]. Then run the following command:
 
 ```shell
-task build:examples-debug
+task examples:build-debug
 ```
 
 ## Running

taskfile.yaml

@@ -4,16 +4,26 @@ set: ["u", "pipefail"]
 shopt: ["globstar"]
 
 includes:
-  build: "taskfiles/build.yaml"
   deps: "taskfiles/deps.yaml"
   docs: "taskfiles/docs.yaml"
+  examples: "taskfiles/examples.yaml"
   lint: "taskfiles/lint.yaml"
+  log-surgeon: "taskfiles/log-surgeon.yaml"
   test: "taskfiles/test.yaml"
 
 vars:
+  # General variables
+  # This must match the package name in CMakeLists.txt.
+  G_CMAKE_PACKAGE_NAME: "log_surgeon"
+
+  # Build directories
   G_BUILD_DIR: "{{.ROOT_DIR}}/build"
   G_EXAMPLES_BUILD_DIR: "{{.G_BUILD_DIR}}/examples"
-  G_LOG_SURGEON_BUILD_DIR: "{{.G_BUILD_DIR}}/log-surgeon"
+  G_EXAMPLES_DEBUG_BUILD_DIR: "{{.G_EXAMPLES_BUILD_DIR}}/debug"
+  G_EXAMPLES_RELEASE_BUILD_DIR: "{{.G_EXAMPLES_BUILD_DIR}}/release"
+  G_LOG_SURGEON_BUILD_DIR: "{{.G_BUILD_DIR}}/{{.G_CMAKE_PACKAGE_NAME}}"
+  G_LOG_SURGEON_DEBUG_BUILD_DIR: "{{.G_LOG_SURGEON_BUILD_DIR}}/debug"
+  G_LOG_SURGEON_RELEASE_BUILD_DIR: "{{.G_LOG_SURGEON_BUILD_DIR}}/release"
 
 tasks:
   clean: "rm -rf '{{.G_BUILD_DIR}}'"

taskfiles/build.yaml

@@ -12,27 +12,23 @@ vars:
   G_DEPS_CMAKE_SETTINGS_DIR: "{{.G_DEPS_DIR}}/cmake-settings"
 
 tasks:
-  default:
-    deps:
-      - "all"
-
-  all:
+  install-all:
     run: "once"
     cmds:
       - task: "utils:cmake:install-deps-and-generate-settings"
         vars:
           CMAKE_SETTINGS_DIR: "{{.G_DEPS_CMAKE_SETTINGS_DIR}}"
-          DEP_TASK: "all-parallel"
+          DEP_TASK: "install-all-parallel"
 
-  all-parallel:
+  install-all-parallel:
     internal: true
     run: "once"
     deps:
-      - "Catch2"
-      - "fmt"
-      - "Microsoft.GSL"
+      - "install-catch2"
+      - "install-fmt"
+      - "install-microsoft.gsl"
 
-  Catch2:
+  install-catch2:
     internal: true
     run: "once"
     cmds:
@@ -48,7 +44,7 @@ tasks:
           TAR_URL: "https://github.com/catchorg/Catch2/archive/refs/tags/v3.8.1.tar.gz"
           WORK_DIR: "{{.G_DEPS_DIR}}"
 
-  fmt:
+  install-fmt:
     internal: true
     run: "once"
     cmds:
@@ -65,7 +61,7 @@ tasks:
           TAR_URL: "https://github.com/fmtlib/fmt/archive/refs/tags/8.0.1.tar.gz"
           WORK_DIR: "{{.G_DEPS_DIR}}"
 
-  Microsoft.GSL:
+  install-microsoft.gsl:
     internal: true
     run: "once"
     cmds:

taskfiles/deps.yaml

@@ -0,0 +1,70 @@
+version: "3"
+
+includes:
+  log-surgeon:
+    internal: true
+    taskfile: "log-surgeon.yaml"
+  utils:
+    internal: true
+    taskfile: "../tools/yscope-dev-utils/exports/taskfiles/utils/utils.yaml"
+
+tasks:
+  build-debug:
+    vars:
+      BUILD_DIR: "{{.G_EXAMPLES_DEBUG_BUILD_DIR}}"
+    deps:
+      - task: "generate"
+        vars:
+          BUILD_DIR: "{{.BUILD_DIR}}"
+          BUILD_TYPE: "debug"
+    cmds:
+      - task: "utils:cmake:build"
+        vars:
+          BUILD_DIR: "{{.BUILD_DIR}}"
+
+  build-release:
+    vars:
+      BUILD_DIR: "{{.G_EXAMPLES_RELEASE_BUILD_DIR}}"
+    deps:
+      - task: "generate"
+        vars:
+          BUILD_DIR: "{{.BUILD_DIR}}"
+          BUILD_TYPE: "release"
+    cmds:
+      - task: "utils:cmake:build"
+        vars:
+          BUILD_DIR: "{{.BUILD_DIR}}"
+
+  clean-debug:
+    cmds:
+      - task: "utils:cmake:clean"
+        vars:
+          BUILD_DIR: "{{.G_EXAMPLES_DEBUG_BUILD_DIR}}"
+
+  clean-release:
+    cmds:
+      - task: "utils:cmake:clean"
+        vars:
+          BUILD_DIR: "{{.G_EXAMPLES_RELEASE_BUILD_DIR}}"
+
+  generate:
+    internal: true
+    requires:
+      vars:
+        - "BUILD_DIR"
+        - "BUILD_TYPE"
+    vars:
+      LOG_SURGEON_INSTALL_PREFIX: >-
+        {{.G_EXAMPLES_BUILD_DIR}}/deps/{{.G_CMAKE_PACKAGE_NAME}}/{{.BUILD_TYPE}}
+    deps:
+      - task: "log-surgeon:install-{{.BUILD_TYPE}}"
+        vars:
+          INSTALL_PREFIX: "{{.LOG_SURGEON_INSTALL_PREFIX}}"
+    cmds:
+      - task: "utils:cmake:generate"
+        vars:
+          BUILD_DIR: "{{.BUILD_DIR}}"
+          EXTRA_ARGS:
+            - "-DCMAKE_BUILD_TYPE={{.BUILD_TYPE}}"
+            - "-D{{.G_CMAKE_PACKAGE_NAME}}_ROOT={{.LOG_SURGEON_INSTALL_PREFIX}}"
+          SOURCE_DIR: "{{.ROOT_DIR}}/examples"