kuksa_databroker-cli_build.yml

# /********************************************************************************
# * Copyright (c) 2022,2023 Contributors to the Eclipse Foundation
# *
# * See the NOTICE file(s) distributed with this work for additional
# * information regarding copyright ownership.
# *
# * This program and the accompanying materials are made available under the
# * terms of the Apache License 2.0 which is available at
# * http://www.apache.org/licenses/LICENSE-2.0
# *
# * SPDX-License-Identifier: Apache-2.0
# ********************************************************************************/

name: Build kuksa-databroker-cli

on:
  push:
    branches: [ main ]
  pull_request:
    paths:
      - ".github/workflows/kuksa_databroker-cli_build.yml"
      - "**"
      - "proto/**"
      - "Cargo.*"
      - "Cross.toml"
  workflow_call:
  workflow_dispatch:

# suffix to avoid cancellation when running from release workflow
concurrency:
      group: ${{ github.ref }}-${{ github.workflow }}-databroker-cli
      cancel-in-progress: true

# Needed as default_workflow_permissions is "read"
permissions:
  packages: write

jobs:
  lint:
    name: Lint
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
      - uses: actions/cache@v4
        with:
          path: |
            ~/.cargo/bin/
            ~/.cargo/registry/index/
            ~/.cargo/registry/cache/
            ~/.cargo/git/db/
            target/
          key: databroker-cli-lint-${{ hashFiles('**/Cargo.lock') }}
      - name: cargo fmt
        working-directory: ${{github.workspace}}
        run: cargo fmt -- --check
      - name: cargo clippy
        working-directory: ${{github.workspace}}
        run: cargo clippy --all-targets -- -W warnings -D warnings

  check_ghcr_push:
    name: Check access rights
    uses: eclipse-kuksa/kuksa-actions/.github/workflows/check_ghcr_push.yml@2
    secrets: inherit

  build-container:
    name: Build multiarch container
    runs-on: ubuntu-latest
    needs: check_ghcr_push

    steps:
    - uses: actions/checkout@v4
      with:
        submodules: recursive
    - uses: actions/cache@v4
      with:
        path: |
          ~/.cargo/bin/
          ~/.cargo/registry/index/
          ~/.cargo/registry/cache/
          ~/.cargo/git/db/
          target/
        key: databroker-cli-release-${{ runner.os }}-${{ hashFiles('**/Cargo.lock') }}

    - name: Install build prerequisites
      working-directory: ${{github.workspace}}/
      run: |
        which cargo-license || cargo install cargo-license
        which cross || cargo install cross
    - name: Building
      working-directory: ${{github.workspace}}/
      run: |
          ./build-all-targets-cli.sh

    - name: Docker meta
      id: meta
      uses: docker/metadata-action@v5
      with:
        # list of Docker images to use as base name for tags
        images: |
          ghcr.io/eclipse-kuksa/kuksa-databroker-cli
        # generate Docker tags based on the following events/attributes
        tags: |
          type=ref,event=branch
          type=ref,event=pr
          type=semver,pattern={{version}}
          type=semver,pattern={{major}}.{{minor}}
          type=semver,pattern={{major}}

    - name: Set up Docker Buildx
      id: buildx
      uses: docker/setup-buildx-action@v3

    - name: Log in to the Container registry
      if: needs.check_ghcr_push.outputs.push == 'true'
      uses: docker/login-action@v3
      with:
          registry: ghcr.io
          username: ${{ github.repository_owner }}
          password: ${{ secrets.GITHUB_TOKEN }}

    - name: Build kuksa-databroker-cli container and push to ghcr.io (and ttl.sh)
      id: ghcr-build
      if: needs.check_ghcr_push.outputs.push == 'true'
      uses: docker/build-push-action@v5
      with:
        platforms: |
          linux/amd64
          linux/arm64
          linux/riscv64
        file: ./Dockerfile-cli
        context: .
        push: true
        tags: |
          ${{ steps.meta.outputs.tags }}
          ttl.sh/eclipse-kuksa/kuksa-databroker-cli-${{github.sha}}
        labels: ${{ steps.meta.outputs.labels }}
        # Provenance to solve that an unknown/unkown image is shown on ghcr.io
        # Same problem as described in https://github.com/orgs/community/discussions/45969
        provenance: false

    - name: Build ephemeral kuksa-databroker-cli container and push to ttl.sh
      if: needs.check_ghcr_push.outputs.push == 'false'
      id: tmp-build
      uses: docker/build-push-action@v5
      with:
        platforms: |
          linux/amd64
          linux/arm64
          linux/riscv64
        file: ./Dockerfile-cli
        context: .
        push: true
        tags: "ttl.sh/eclipse-kuksa/kuksa-databroker-cli-${{github.sha}}"
        labels: ${{ steps.meta.outputs.labels }}
        # Provenance to solve that an unknown/unkown image is shown on ghcr.io
        # Same problem as described in https://github.com/orgs/community/discussions/45969
        provenance: false

    - name: Posting message
      uses: eclipse-kuksa/kuksa-actions/post-container-location@2
      with:
        image: ttl.sh/eclipse-kuksa/kuksa-databroker-cli-${{github.sha}}
    - name: Pack binaries with thirdparty
      env:
        AMD64_DIR: ${{ github.workspace }}/dist/amd64
        ARM64_DIR: ${{ github.workspace }}/dist/arm64
        RISCV64_DIR: ${{ github.workspace }}/dist/riscv64
      run: |
          cd "$AMD64_DIR"
          tar czf databroker-cli-amd64.tar.gz *
          cd "$ARM64_DIR"
          tar czf databroker-cli-arm64.tar.gz *
          cd "$RISCV64_DIR"
          tar czf databroker-cli-riscv64.tar.gz *

    - name: "Archiving AMD64 artifacts"
      uses: actions/upload-artifact@v4
      with:
        name: databroker-cli-amd64.tar.gz
        path: ${{github.workspace}}/dist/amd64/databroker-cli-amd64.tar.gz

    - name: "Archiving ARM64 artifacts"
      uses: actions/upload-artifact@v4
      with:
        name: databroker-cli-arm64.tar.gz
        path: ${{github.workspace}}/dist/arm64/databroker-cli-arm64.tar.gz

    - name: "Archiving RISCV64 artifacts"
      uses: actions/upload-artifact@v4
      with:
        name: databroker-cli-riscv64.tar.gz
        path: ${{github.workspace}}/dist/riscv64/databroker-cli-riscv64.tar.gz


  bom:
    name: Check Bill of Material
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
      - uses: actions/cache@v4
        with:
          path: |
            ~/.cargo/bin/
            ~/.cargo/registry/index/
            ~/.cargo/registry/cache/
            ~/.cargo/git/db/
            target/
          key: databroker-cli-bom-${{ hashFiles('**/Cargo.lock') }}

      - name: "Createbom: License check and Dash output generation"
        working-directory: ${{github.workspace}}/createbom
        run: |
         which cargo-license || cargo install cargo-license
         python3 createbom.py --dash ${{github.workspace}}/dash-databroker-cli ../databroker

      - name: Dash license check
        uses: eclipse-kuksa/kuksa-actions/check-dash@3
        with:
          dashinput: ${{github.workspace}}/dash-databroker-cli