Add C++ profile to Docker Compose and Updatecli (#1004)

gounthar · dependabot[bot] · actions-user · web-flow · commit bd6b06ed8fc0 · 2025-02-21T14:17:59.000+01:00
* chore(deps): bump debian in /dockerfiles/sidekick Bumps debian from bookworm-20231218 to bookworm-20240110. --- updated-dependencies: - dependency-name: debian dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(deps): bump updatecli/updatecli-action from 2.52.0 to 2.53.0 Bumps [updatecli/updatecli-action](https://github.com/updatecli/updatecli-action) from 2.52.0 to 2.53.0. - [Release notes](https://github.com/updatecli/updatecli-action/releases) - [Commits](updatecli/updatecli-action@v2.52.0...v2.53.0) --- updated-dependencies: - dependency-name: updatecli/updatecli-action dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * chore(deps): bump anchore/scan-action from 3.5.0 to 3.6.0 Bumps [anchore/scan-action](https://github.com/anchore/scan-action) from 3.5.0 to 3.6.0. - [Release notes](https://github.com/anchore/scan-action/releases) - [Changelog](https://github.com/anchore/scan-action/blob/main/CHANGELOG.md) - [Commits](anchore/scan-action@1d59d90...0550541) --- updated-dependencies: - dependency-name: anchore/scan-action dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * chore(jenkins): Update Jenkins plugins * chore(deps): bump updatecli/updatecli-action from 2.53.0 to 2.54.0 Bumps [updatecli/updatecli-action](https://github.com/updatecli/updatecli-action) from 2.53.0 to 2.54.0. - [Release notes](https://github.com/updatecli/updatecli-action/releases) - [Commits](updatecli/updatecli-action@v2.53.0...v2.54.0) --- updated-dependencies: - dependency-name: updatecli/updatecli-action dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * chore(deps): bump debian in /dockerfiles/sidekick Bumps debian from bookworm-20240110 to bookworm-20240130. --- updated-dependencies: - dependency-name: debian dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> * chore(deps): bump jenkins/ssh-agent in /dockerfiles/python Bumps jenkins/ssh-agent from 5.22.0 to 5.24.0. --- updated-dependencies: - dependency-name: jenkins/ssh-agent dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * chore(deps): bump jenkins/ssh-agent in /dockerfiles/android Bumps jenkins/ssh-agent from 5.22.0 to 5.24.0. --- updated-dependencies: - dependency-name: jenkins/ssh-agent dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * chore(deps): bump jenkins/ssh-agent in /dockerfiles/maven Bumps jenkins/ssh-agent from 5.22.0 to 5.24.0. --- updated-dependencies: - dependency-name: jenkins/ssh-agent dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * chore(deps): bump release-drafter/release-drafter from 5 to 6 Bumps [release-drafter/release-drafter](https://github.com/release-drafter/release-drafter) from 5 to 6. - [Release notes](https://github.com/release-drafter/release-drafter/releases) - [Commits](release-drafter/release-drafter@v5...v6) --- updated-dependencies: - dependency-name: release-drafter/release-drafter dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> * chore(deps): bump anchore/scan-action from 3.6.0 to 3.6.4 Bumps [anchore/scan-action](https://github.com/anchore/scan-action) from 3.6.0 to 3.6.4. - [Release notes](https://github.com/anchore/scan-action/releases) - [Changelog](https://github.com/anchore/scan-action/blob/main/CHANGELOG.md) - [Commits](anchore/scan-action@0550541...3343887) --- updated-dependencies: - dependency-name: anchore/scan-action dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * chore(deps): bump jenkins/ssh-agent in /dockerfiles/multi Bumps jenkins/ssh-agent from 5.22.0 to 5.24.0. --- updated-dependencies: - dependency-name: jenkins/ssh-agent dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * chore(deps): bump jenkins/ssh-agent in /dockerfiles/node Bumps jenkins/ssh-agent from 5.22.0 to 5.24.0. --- updated-dependencies: - dependency-name: jenkins/ssh-agent dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * chore(deps): bump codacy/codacy-analysis-cli-action from 4.3.0 to 4.4.0 Bumps [codacy/codacy-analysis-cli-action](https://github.com/codacy/codacy-analysis-cli-action) from 4.3.0 to 4.4.0. - [Release notes](https://github.com/codacy/codacy-analysis-cli-action/releases) - [Commits](codacy/codacy-analysis-cli-action@5cc54a7...33d4559) --- updated-dependencies: - dependency-name: codacy/codacy-analysis-cli-action dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(deps): bump debian in /dockerfiles/sidekick Bumps debian from bookworm-20240130 to bookworm-20240211. --- updated-dependencies: - dependency-name: debian dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> * chore(deps): bump updatecli/updatecli-action from 2.54.0 to 2.55.0 (#114) * chore(deps): bump jenkins/ssh-agent in /dockerfiles/multi (#115) * chore(deps): bump jenkins/ssh-agent in /dockerfiles/node (#116) * chore(deps): bump jenkins/ssh-agent in /dockerfiles/android (#117) * chore(deps): bump jenkins/ssh-agent in /dockerfiles/maven (#118) * chore(deps): bump jenkins/ssh-agent in /dockerfiles/python (#119) * chore(jenkins): Update Jenkins plugins * Multi controller is the same as simple controller * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(deps): Bump debian in /dockerfiles/sidekick Bumps debian from bookworm-20240311 to bookworm-20240408. --- updated-dependencies: - dependency-name: debian dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> * chore(jenkins): Update Jenkins plugins * chore(deps): bump codacy/codacy-analysis-cli-action from 4.4.0 to 4.4.1 Bumps [codacy/codacy-analysis-cli-action](https://github.com/codacy/codacy-analysis-cli-action) from 4.4.0 to 4.4.1. - [Release notes](https://github.com/codacy/codacy-analysis-cli-action/releases) - [Commits](codacy/codacy-analysis-cli-action@33d4559...3ff8e64) --- updated-dependencies: - dependency-name: codacy/codacy-analysis-cli-action dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * chore(deps): bump updatecli/updatecli-action from 2.57.0 to 2.58.0 Bumps [updatecli/updatecli-action](https://github.com/updatecli/updatecli-action) from 2.57.0 to 2.58.0. - [Release notes](https://github.com/updatecli/updatecli-action/releases) - [Commits](updatecli/updatecli-action@v2.57.0...v2.58.0) --- updated-dependencies: - dependency-name: updatecli/updatecli-action dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(deps): bump updatecli/updatecli-action from 2.58.0 to 2.59.0 Bumps [updatecli/updatecli-action](https://github.com/updatecli/updatecli-action) from 2.58.0 to 2.59.0. - [Release notes](https://github.com/updatecli/updatecli-action/releases) - [Commits](updatecli/updatecli-action@v2.58.0...v2.59.0) --- updated-dependencies: - dependency-name: updatecli/updatecli-action dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * Update Docker versions * Not to be lost. * not to be lost * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * chore(jenkins): Update Jenkins plugins * Add C++ profile to Docker Compose and Updatecli Fixes #376 Add a new profile in the Docker Compose file for building C++ source code with Jenkins. * **Docker Compose Files:** * Add a `cpp` profile in `docker-compose.yaml` and `build-docker-compose.yaml`. * Include necessary service definitions, dependencies, healthcheck, and volume configurations. * **Dockerfile:** * Create `dockerfiles/cpp/Dockerfile` with necessary C++ build tools including `build-essential`, `cmake`, `gcc`, `g++`, `clang`, `make`, `libstdc++-dev`, and `pkg-config`. * Set environment variables and ensure ownership of the Jenkins agent home directory. * **Updatecli Manifest:** * Add `updatecli/updatecli.d/cpp.yaml` for managing the C++ Dockerfile. * Ensure the manifest includes the necessary dependencies for the C++ build environment. * **GitHub Actions:** * Modify `.github/workflows/github-docker-registry-push.yml` to add a new job for building and pushing the C++ Docker image to ghcr. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/gounthar/quickstart-tutorials/issues/376?shareId=XXXX-XXXX-XXXX-XXXX). * fix(updatecli): Removed cpp manifest. * fix(docker): Update libstdc++ dependency to libstdc++-12-dev * feat(jenkins): Add cpp-agent configuration for Docker image in ssh-agent.yaml --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: GitHub Action <action@github.com>
diff --git a/.github/workflows/github-docker-registry-push.yml b/.github/workflows/github-docker-registry-push.yml
@@ -204,3 +204,13 @@ jobs:
           platforms: linux/amd64, linux/arm64
           push: true
           tags: ghcr.io/${{ env.REPO_NAME }}/jenkinsci-tutorials:golang_${{ env.BRANCH }}
+
+      - name: Build and push the jenkins agent for cpp tutorial
+        # This step builds and pushes the Jenkins agent for the C++ tutorial
+        if: contains(env.files, 'dockerfiles/cpp/Dockerfile')
+        uses: docker/build-push-action@v6
+        with:
+          context: ./dockerfiles/cpp
+          platforms: linux/amd64, linux/aarch64
+          push: true
+          tags: ghcr.io/${{ env.REPO_NAME }}/jenkinsci-tutorials:cpp_agent_${{ env.BRANCH }}
diff --git a/build-docker-compose.yaml b/build-docker-compose.yaml
@@ -205,6 +205,23 @@ services:
       retries: 5
     volumes:
       - agent-ssh-dir:/home/jenkins/.ssh:ro # Mounts the agent-ssh-dir volume to the /home/jenkins/.ssh path inside the container as read-only
+  cpp:
+    build: dockerfiles/cpp/.
+    container_name: desktop-jenkins_agent-1-cpp
+    profiles:
+      - cpp
+    depends_on:
+      sidekick_service:
+        condition: service_completed_successfully
+      jenkins_controller:
+        condition: service_started
+    healthcheck:
+      test: ["CMD-SHELL", "[ -f /home/jenkins/.ssh/authorized_keys ] || exit 1"]
+      interval: 5s
+      timeout: 10s
+      retries: 5
+    volumes:
+      - agent-ssh-dir:/home/jenkins/.ssh:ro
 volumes:
   jenkins_home: null
   agent-ssh-dir:
diff --git a/docker-compose.yaml b/docker-compose.yaml
@@ -281,6 +281,23 @@ services:
       retries: 5
     volumes:
       - agent-ssh-dir:/home/jenkins/.ssh:ro # Mounts the agent-ssh-dir volume to the /home/jenkins/.ssh path inside the container as read-only
+  cpp:
+    image: ${IMAGE_PREFIX}/${GHCR_USERNAME}/quickstart-tutorials/jenkinsci-tutorials:cpp_agent_${BRANCH_SUFFIX}
+    container_name: desktop-jenkins_agent-1-cpp
+    profiles:
+      - cpp
+    depends_on:
+      sidekick_service:
+        condition: service_completed_successfully
+      jenkins_controller:
+        condition: service_started
+    healthcheck:
+      test: ["CMD-SHELL", "[ -f /home/jenkins/.ssh/authorized_keys ] || exit 1"]
+      interval: 5s
+      timeout: 10s
+      retries: 5
+    volumes:
+      - agent-ssh-dir:/home/jenkins/.ssh:ro
 volumes:
   jenkins_home: null
   empty_jenkins_home: null
diff --git a/dockerfiles/cpp/Dockerfile b/dockerfiles/cpp/Dockerfile
@@ -0,0 +1,19 @@
+FROM jenkins/ssh-agent:6.9.0
+
+# Install necessary C++ build tools
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    build-essential \
+    cmake \
+    gcc \
+    g++ \
+    clang \
+    make \
+    libstdc++-12-dev \
+    pkg-config \
+    && rm -rf /var/lib/apt/lists/*
+
+# Set environment variables
+ENV PATH="/usr/local/bin:$PATH"
+
+# Ensure the ownership of the Jenkins agent home directory is set to the Jenkins user
+RUN chown -R jenkins:jenkins "${JENKINS_AGENT_HOME}"
diff --git a/extract-profiles.sh b/extract-profiles.sh
@@ -0,0 +1,51 @@
+#!/bin/bash
+set -e
+
+original_file="docker-compose.yaml"
+
+# Function to add a service and its dependencies to the included_services list
+add_service_and_dependencies() {
+    local service=$1
+    # Mark the service as included
+    included_services["$service"]=1
+    # Check if the service has dependencies
+    if yq e ".services.${service}.depends_on" "$original_file" -e > /dev/null; then
+        # Read dependencies of the service
+        local dependencies=($(yq e ".services.${service}.depends_on | keys" "$original_file" -o json | jq -r '.[]'))
+        # Recursively add dependencies
+        for dependency in "${dependencies[@]}"; do
+            if [[ -z "${included_services["$dependency"]}" ]]; then
+                add_service_and_dependencies "$dependency"
+            fi
+        done
+    fi
+}
+
+# Step 1: Collect all dependencies
+declare -A all_dependencies
+services=$(yq e '.services | keys' "$original_file" -o json | jq -r '.[]')
+for service in $services; do
+    dependencies=$(yq e ".services.$service.depends_on | keys" "$original_file" -o json | jq -r '.[]')
+    for dependency in $dependencies; do
+        all_dependencies["$dependency"]=1
+    done
+done
+
+# Step 2: Process each profile and include dependencies
+for profile in $(yq e '.services[].profiles[]?' "$original_file" | sort -u); do
+    echo "Processing profile: $profile"
+    # Initialize an associative array to track included services
+    declare -A included_services
+    # Find and include services matching the profile
+    matching_services=$(yq e ".services | with_entries(select(.value.profiles[]? == \"$profile\")) | keys" "$original_file" -o json | jq -r '.[]')
+    for service in $matching_services; do
+        add_service_and_dependencies "$service"
+    done
+    # Correctly format the list of included services for yq query
+    included_services_keys=$(printf "'%s'," "${!included_services[@]}")
+    included_services_keys="[${included_services_keys%,}]" # Remove trailing comma and wrap in brackets
+
+    # Generate the docker-compose file for the profile
+    echo "Generating docker-compose-$profile.yaml"
+    yq e ".services | with_entries(select(.key as \$k | .key == \"$included_services_list\"))" "$original_file" > "docker-compose-$profile.yaml"
+done
diff --git a/updatecli/updatecli.d/ssh-agent.yaml b/updatecli/updatecli.d/ssh-agent.yaml
@@ -85,6 +85,16 @@ targets:
         matcher: jenkins/ssh-agent
     sourceid: jenkins/ssh-agent
     scmid: default
+  jenkins/cpp-agent:
+    name: '[jenkins/ssh-agent] Bump Docker image tag in "dockerfiles/cpp/Dockerfile"'
+    kind: dockerfile
+    spec:
+      file: dockerfiles/cpp/Dockerfile
+      instruction:
+        keyword: FROM
+        matcher: jenkins/ssh-agent
+    sourceid: jenkins/ssh-agent
+    scmid: default
   default-agent:
     name: '[jenkins/ssh-agent] Bump Docker image tag in "docker-compose.yaml"'
     kind: yaml
