Discussion: CI: Reusable GitHub Workflow and Actions for Building Packages

.github/actions/sil-kit-ci/build-sil-kit/action.yml

@@ -0,0 +1,150 @@
+name: sil-kit-ci/build-sil-kit
+
+description: Run the SIL Kit CI builds.
+
+inputs:
+
+  preset-name:
+    description: The preset name from CMakePresets.json
+    required: true
+
+  linux-docker-image:
+    description: Docker image used under Linux
+    required: true
+
+  c-compiler:
+    description: C compiler used under Linux
+    required: true
+
+  cxx-compiler:
+    description: C++ compiler used under Linux
+    required: true
+
+  msvc-arch:
+    description: Target architecture used under Windows/MSVC
+    required: true
+
+  msvc-toolset:
+    description: Target toolset used under Windows/MSVC
+    required: true
+
+  upload-artifacts:
+    description: Determines if artifacts created by the actions should be uploaded
+    required: true
+
+  retention-days:
+    description: Determines the number of days any uploaded artifacts should be retained
+    required: true
+
+  package-name:
+    description: Name of the package to upload as an artifact
+    required: true
+
+  cmake-configure-args:
+    description: Extra arguments passed to cmake during configuration
+    required: true
+
+  cmake-build-args:
+    description: Extra arguments passed to cmake during building
+    required: true
+
+  ctest-args:
+    description: Extra arguments passed to ctest
+    required: true
+
+  cmake-package-args:
+    description: Extra arguments passed to cmake during packaging
+    required: true
+
+runs:
+  using: composite
+  steps:
+
+      # setup: compute directories for the sil-kit build
+
+    - uses: ./.github/actions/sil-kit-ci/impl-setup
+      id: setup
+      with:
+        linux-docker-image: ${{ inputs.linux-docker-image }}
+        c-compiler: ${{ inputs.c-compiler }}
+        cxx-compiler: ${{ inputs.cxx-compiler }}
+        msvc-arch: ${{ inputs.msvc-arch }}
+        msvc-toolset: ${{ inputs.msvc-toolset }}
+
+    - shell: bash
+      id: dirs
+      run: |
+        # compute directories
+        echo "work-dir=${{ steps.setup.outputs.work-dir }}" >> "$GITHUB_ENV"
+
+    - shell: bash
+      run: |
+        # remove source, build, and package directories
+        rm -rfv ${{ env.work-dir }}/{src,bld,pkg}/sil-kit
+
+    # checkout
+
+    - name: checkout sil-kit sources
+      uses: actions/checkout@v4
+      with:
+        path: ${{ env.work-dir }}/src/sil-kit
+        submodules: true
+
+    # configure, build, test, and package
+
+    - name: configure cmake project
+      uses: ./.github/actions/sil-kit-ci/impl-execute
+      with:
+        linux-docker-image: ${{ inputs.linux-docker-image }}
+        work-dir: ${{ env.work-dir }}
+        relative-working-dir: src/sil-kit
+        command: >
+          cmake
+          -B "${WORK_DIR}/bld/sil-kit"
+          --preset "${{ inputs.preset-name }}"
+          ${{ steps.setup.outputs.cmake-configure-args }}
+          ${{ inputs.cmake-configure-args }}
+          -D CPACK_PACKAGE_DIRECTORY="${WORK_DIR}/pkg/sil-kit"
+
+    - name: build cmake project
+      uses: ./.github/actions/sil-kit-ci/impl-execute
+      with:
+        linux-docker-image: ${{ inputs.linux-docker-image }}
+        work-dir: ${{ env.work-dir }}
+        relative-working-dir: bld/sil-kit
+        command: >
+          cmake
+          --build .
+          --parallel
+          ${{ inputs.cmake-build-args }}
+
+    - name: test cmake project
+      uses: ./.github/actions/sil-kit-ci/impl-execute
+      with:
+        linux-docker-image: ${{ inputs.linux-docker-image }}
+        work-dir: ${{ env.work-dir }}
+        relative-working-dir: bld/sil-kit
+        command: >
+          ctest
+          ${{ inputs.ctest-args }}
+
+    - name: package cmake project
+      uses: ./.github/actions/sil-kit-ci/impl-execute
+      with:
+        linux-docker-image: ${{ inputs.linux-docker-image }}
+        work-dir: ${{ env.work-dir }}
+        relative-working-dir: bld/sil-kit
+        command: >
+          cmake
+          --build .
+          --target package
+          ${{ inputs.cmake-package-args }}
+
+    - name: upload package as artifact
+      if: ${{ inputs.upload-artifacts == 'true' }}
+      uses: actions/upload-artifact@v4
+      with:
+        name: ${{ inputs.package-name }}
+        path: ${{ env.work-dir }}/pkg/sil-kit/SilKit-*-*.zip
+        retention-days: ${{ inputs.retention-days }}
+        if-no-files-found: 'error'

.github/actions/sil-kit-ci/impl-execute/action.yml

@@ -0,0 +1,68 @@
+name: sil-kit-ci/impl-execute
+
+description: >
+  Execute a command with arguments.
+
+  Access to files in the `work-dir` must use the `WORK_DIR` environment variable in the command.
+  This is required to provide transparent support for execution of the command inside of a docker container.
+
+  On Linux runners, the command is executed in a docker container using the `linux-docker-image`.
+  On Windows runners, the command is executed on the runner itself.
+
+inputs:
+
+  work-dir:
+    required: false
+    description: >
+      The command being executed must only access (read and write) files in the work-directory.
+      On Linux: volume-mounted into a docker container
+
+  relative-working-dir:
+    required: false
+    description: >
+      Relative path to the initial working directory inside the `work-directory` (can be empty)
+
+  linux-docker-image:
+    required: false
+    description: Docker image used under Linux.
+
+  command:
+    required: true
+    description: Command line to be executed.
+
+runs:
+  using: composite
+  steps:
+
+    - shell: bash
+      env:
+        STRING: ${{ inputs.command }}
+      run: |
+        # check if inputs.command contains a newline
+
+        # remove trailing newlines and spaces before the check
+        STRING="${STRING%%[[:space:]]}"
+
+        if [[ "${STRING}" == *$'\n'* ]] ; then
+          echo "::error title=invalid command::must not contain newline characters"
+          exit 1
+        fi
+
+    - name: (linux) execute command
+      if: runner.os == 'Linux'
+      shell: bash
+      run: |
+        WORK_DIR="/w"
+        docker run \
+          -v "${{ inputs.work-dir }}:/w" \
+          -w "/w/${{ inputs.relative-working-dir }}" \
+          "${{ inputs.linux-docker-image }}" \
+            ${{ inputs.command }}
+
+    - name: (windows) execute command
+      if: runner.os == 'Windows'
+      shell: powershell
+      working-directory: ${{ inputs.work-dir }}/${{ inputs.relative-working-dir }}
+      run: |
+        $WORK_DIR = "${{ inputs.work-dir }}"
+        ${{ inputs.command }}