DistTasks.yml

# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/release-go-task/DistTasks.yml
version: "3"

# This taskfile is ideally meant to be project agnostic and could be dropped in
# on other Go projects with minimal or no changes.
#
# To use it simply add the following lines to your main taskfile:
#   includes:
#     dist: ./DistTasks.yml
#
# The following variables must be declared in the including taskfile for the
# build process to work correctly:
# * DIST_DIR: the folder that will contain the final binaries and packages
# * PROJECT_NAME: the name of the project, used in package name
# * VERSION: the version of the project, used in package name and checksum file
# * LD_FLAGS: flags used at build time
#
# The project MUST contain a LICENSE.txt file in the root folder or packaging will fail.

vars:
  CONTAINER: "docker.elastic.co/beats-dev/golang-crossbuild"
  GO_VERSION: "1.20.5"

tasks:
  Windows_32bit:
    desc: Builds Windows 32 bit binaries
    dir: "{{.DIST_DIR}}"
    cmds:
      - |
        mkdir {{.PLATFORM_DIR}}
        cp ../LICENSE.txt {{.PLATFORM_DIR}}/
        docker run -v `pwd`/..:/home/build -w /home/build \
        -e CGO_ENABLED=1 \
        {{.CONTAINER}}:{{.CONTAINER_TAG}} \
        --build-cmd "{{.BUILD_COMMAND}}" \
        -p "{{.BUILD_PLATFORM}}"

        zip {{.PACKAGE_NAME}} {{.PLATFORM_DIR}}/{{.PROJECT_NAME}}.exe {{.PLATFORM_DIR}}/LICENSE.txt

    vars:
      PLATFORM_DIR: "{{.PROJECT_NAME}}_windows_386"
      BUILD_COMMAND: >
        go build -o {{.DIST_DIR}}/{{.PLATFORM_DIR}}/{{.PROJECT_NAME}}.exe {{.LDFLAGS}}
      BUILD_PLATFORM: "windows/386"
      CONTAINER_TAG: "{{.GO_VERSION}}-main"
      PACKAGE_PLATFORM: "Windows_32bit"
      PACKAGE_NAME: "{{.PROJECT_NAME}}_{{.VERSION}}_{{.PACKAGE_PLATFORM}}.zip"

  Windows_64bit:
    desc: Builds Windows 64 bit binaries
    dir: "{{.DIST_DIR}}"
    cmds:
      - |
        mkdir {{.PLATFORM_DIR}}
        cp ../LICENSE.txt {{.PLATFORM_DIR}}/
        docker run -v `pwd`/..:/home/build -w /home/build \
        -e CGO_ENABLED=1 \
        {{.CONTAINER}}:{{.CONTAINER_TAG}} \
        --build-cmd "{{.BUILD_COMMAND}}" \
        -p "{{.BUILD_PLATFORM}}"

        zip {{.PACKAGE_NAME}} {{.PLATFORM_DIR}}/{{.PROJECT_NAME}}.exe {{.PLATFORM_DIR}}/LICENSE.txt

    vars:
      PLATFORM_DIR: "{{.PROJECT_NAME}}_windows_amd64"
      BUILD_COMMAND: >
        go build -o {{.DIST_DIR}}/{{.PLATFORM_DIR}}/{{.PROJECT_NAME}}.exe {{.LDFLAGS}}
      BUILD_PLATFORM: "windows/amd64"
      CONTAINER_TAG: "{{.GO_VERSION}}-main"
      PACKAGE_PLATFORM: "Windows_64bit"
      PACKAGE_NAME: "{{.PROJECT_NAME}}_{{.VERSION}}_{{.PACKAGE_PLATFORM}}.zip"

  Linux_32bit:
    desc: Builds Linux 32 bit binaries
    dir: "{{.DIST_DIR}}"
    cmds:
      - |
        mkdir {{.PLATFORM_DIR}}
        cp ../LICENSE.txt {{.PLATFORM_DIR}}/
        docker run -v `pwd`/..:/home/build -w /home/build \
        -e CGO_ENABLED=1 \
        {{.CONTAINER}}:{{.CONTAINER_TAG}} \
        --build-cmd "{{.BUILD_COMMAND}}" \
        -p "{{.BUILD_PLATFORM}}"

        tar cz {{.PLATFORM_DIR}} -f {{.PACKAGE_NAME}}

    vars:
      PLATFORM_DIR: "{{.PROJECT_NAME}}_linux_amd32"
      BUILD_COMMAND: >
        go build -o {{.DIST_DIR}}/{{.PLATFORM_DIR}}/{{.PROJECT_NAME}} {{.LDFLAGS}}
      BUILD_PLATFORM: "linux/386"
      CONTAINER_TAG: "{{.GO_VERSION}}-main"
      PACKAGE_PLATFORM: "Linux_32bit"
      PACKAGE_NAME: "{{.PROJECT_NAME}}_{{.VERSION}}_{{.PACKAGE_PLATFORM}}.tar.gz"

  Linux_64bit:
    desc: Builds Linux 64 bit binaries
    dir: "{{.DIST_DIR}}"
    cmds:
      - |
        mkdir {{.PLATFORM_DIR}}
        cp ../LICENSE.txt {{.PLATFORM_DIR}}/
        docker run -v `pwd`/..:/home/build -w /home/build \
        -e CGO_ENABLED=1 \
        {{.CONTAINER}}:{{.CONTAINER_TAG}} \
        --build-cmd "{{.BUILD_COMMAND}}" \
        -p "{{.BUILD_PLATFORM}}"

        tar cz {{.PLATFORM_DIR}} -f {{.PACKAGE_NAME}}

    vars:
      PLATFORM_DIR: "{{.PROJECT_NAME}}_linux_amd64"
      BUILD_COMMAND: >
        go build -o {{.DIST_DIR}}/{{.PLATFORM_DIR}}/{{.PROJECT_NAME}} {{.LDFLAGS}}
      BUILD_PLATFORM: "linux/amd64"
      CONTAINER_TAG: "{{.GO_VERSION}}-main"
      PACKAGE_PLATFORM: "Linux_64bit"
      PACKAGE_NAME: "{{.PROJECT_NAME}}_{{.VERSION}}_{{.PACKAGE_PLATFORM}}.tar.gz"

  Linux_ARMv7:
    desc: Builds Linux ARMv7 binaries
    dir: "{{.DIST_DIR}}"
    cmds:
      - |
        mkdir {{.PLATFORM_DIR}}
        cp ../LICENSE.txt {{.PLATFORM_DIR}}/
        docker run -v `pwd`/..:/home/build -w /home/build \
        -e CGO_ENABLED=1 \
        {{.CONTAINER}}:{{.CONTAINER_TAG}} \
        --build-cmd "{{.BUILD_COMMAND}}" \
        -p "{{.BUILD_PLATFORM}}"

        tar cz {{.PLATFORM_DIR}} -f {{.PACKAGE_NAME}}

    vars:
      PLATFORM_DIR: "{{.PROJECT_NAME}}_linux_arm_7"
      BUILD_COMMAND: >
        go build -o {{.DIST_DIR}}/{{.PLATFORM_DIR}}/{{.PROJECT_NAME}} {{.LDFLAGS}}
      BUILD_PLATFORM: "linux/armv7"
      CONTAINER_TAG: "{{.GO_VERSION}}-armhf"
      PACKAGE_PLATFORM: "Linux_ARMv7"
      PACKAGE_NAME: "{{.PROJECT_NAME}}_{{.VERSION}}_{{.PACKAGE_PLATFORM}}.tar.gz"

  Linux_ARMv6:
    desc: Builds Linux ARMv6 binaries
    dir: "{{.DIST_DIR}}"
    cmds:
      - |
        mkdir {{.PLATFORM_DIR}}
        cp ../LICENSE.txt {{.PLATFORM_DIR}}/
        docker run -v `pwd`/..:/home/build -w /home/build \
        -e CGO_ENABLED=1 \
        {{.CONTAINER}}:{{.CONTAINER_TAG}} \
        --build-cmd "{{.BUILD_COMMAND}}" \
        -p "{{.BUILD_PLATFORM}}"

        tar cz {{.PLATFORM_DIR}} -f {{.PACKAGE_NAME}}

    vars:
      PLATFORM_DIR: "{{.PROJECT_NAME}}_linux_arm_6"
      BUILD_COMMAND: >
        go build -o {{.DIST_DIR}}/{{.PLATFORM_DIR}}/{{.PROJECT_NAME}} {{.LDFLAGS}}
      BUILD_PLATFORM: "linux/armv6"
      CONTAINER_TAG: "{{.GO_VERSION}}-armel-debian9"
      PACKAGE_PLATFORM: "Linux_ARMv6"
      PACKAGE_NAME: "{{.PROJECT_NAME}}_{{.VERSION}}_{{.PACKAGE_PLATFORM}}.tar.gz"

  Linux_ARM64:
    desc: Builds Linux ARM64 binaries
    dir: "{{.DIST_DIR}}"
    cmds:
      - |
        mkdir {{.PLATFORM_DIR}}
        cp ../LICENSE.txt {{.PLATFORM_DIR}}/
        docker run -v `pwd`/..:/home/build -w /home/build \
        -e CGO_ENABLED=1 \
        {{.CONTAINER}}:{{.CONTAINER_TAG}} \
        --build-cmd "{{.BUILD_COMMAND}}" \
        -p "{{.BUILD_PLATFORM}}"

        tar cz {{.PLATFORM_DIR}} -f {{.PACKAGE_NAME}}

    vars:
      PLATFORM_DIR: "{{.PROJECT_NAME}}_linux_arm_64"
      BUILD_COMMAND: >
        go build -o {{.DIST_DIR}}/{{.PLATFORM_DIR}}/{{.PROJECT_NAME}} {{.LDFLAGS}}
      BUILD_PLATFORM: "linux/arm64"
      CONTAINER_TAG: "{{.GO_VERSION}}-arm"
      PACKAGE_PLATFORM: "Linux_ARM64"
      PACKAGE_NAME: "{{.PROJECT_NAME}}_{{.VERSION}}_{{.PACKAGE_PLATFORM}}.tar.gz"

  macOS_64bit:
    desc: Builds Mac OS X 64 bit binaries
    dir: "{{.DIST_DIR}}"
    cmds:
      # "git config safe.directory" is required until this is fixed https://github.com/elastic/golang-crossbuild/issues/232
      - |
        mkdir {{.PLATFORM_DIR}}
        cp ../LICENSE.txt {{.PLATFORM_DIR}}/
        docker run -v `pwd`/..:/home/build -w /home/build \
        -e CGO_ENABLED=1 \
        {{.CONTAINER}}:{{.CONTAINER_TAG}} \
        --build-cmd "git config --global --add safe.directory /home/build && {{.BUILD_COMMAND}}" \
        -p "{{.BUILD_PLATFORM}}"

        tar cz {{.PLATFORM_DIR}} -f {{.PACKAGE_NAME}}

    vars:
      PLATFORM_DIR: "{{.PROJECT_NAME}}_osx_darwin_amd64"
      BUILD_COMMAND: >
        go build -o {{.DIST_DIR}}/{{.PLATFORM_DIR}}/{{.PROJECT_NAME}} {{.LDFLAGS}}
      BUILD_PLATFORM: "darwin/amd64"
      CONTAINER_TAG: "{{.GO_VERSION}}-darwin-debian10"
      PACKAGE_PLATFORM: "macOS_64bit"
      PACKAGE_NAME: "{{.PROJECT_NAME}}_{{.VERSION}}_{{.PACKAGE_PLATFORM}}.tar.gz"

  macOS_ARM64:
    desc: Builds Mac OS X ARM64 binaries
    dir: "{{.DIST_DIR}}"
    cmds:
      # "git config safe.directory" is required until this is fixed https://github.com/elastic/golang-crossbuild/issues/232
      - |
        mkdir {{.PLATFORM_DIR}}
        cp ../LICENSE.txt {{.PLATFORM_DIR}}/
        docker run -v `pwd`/..:/home/build -w /home/build \
        -e CGO_ENABLED=1 \
        {{.CONTAINER}}:{{.CONTAINER_TAG}} \
        --build-cmd "git config --global --add safe.directory /home/build && {{.BUILD_COMMAND}}" \
        -p "{{.BUILD_PLATFORM}}"

        tar cz {{.PLATFORM_DIR}} -f {{.PACKAGE_NAME}}

    vars:
      PLATFORM_DIR: "{{.PROJECT_NAME}}_osx_darwin_arm64"
      BUILD_COMMAND: >
        go build -o {{.DIST_DIR}}/{{.PLATFORM_DIR}}/{{.PROJECT_NAME}} {{.LDFLAGS}}
      BUILD_PLATFORM: "darwin/arm64"
      CONTAINER_TAG: "{{.GO_VERSION}}-darwin-arm64-debian10"
      PACKAGE_PLATFORM: "macOS_ARM64"
      PACKAGE_NAME: "{{.PROJECT_NAME}}_{{.VERSION}}_{{.PACKAGE_PLATFORM}}.tar.gz"

  generate-index-data:
    desc: Generates json for platform index
    vars:
      WINDOWS32_SHA:
        sh: sha256sum {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_Windows_32bit.zip | cut -f1 -d " "
      WINDOWS64_SHA:
        sh: sha256sum {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_Windows_64bit.zip | cut -f1 -d " "
      LINUX32_SHA:
        sh: sha256sum {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_Linux_32bit.tar.gz | cut -f1 -d " "
      LINUX64_SHA:
        sh: sha256sum {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_Linux_64bit.tar.gz | cut -f1 -d " "
      LINUXARM_SHA:
        sh: sha256sum {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_Linux_ARMv6.tar.gz | cut -f1 -d " "
      LINUXARM64_SHA:
        sh: sha256sum {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_Linux_ARM64.tar.gz | cut -f1 -d " "
      OSX64_SHA:
        sh: sha256sum {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_macOS_64bit.tar.gz | cut -f1 -d " "
      OSXARM64_SHA:
        sh: sha256sum {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_macOS_ARM64.tar.gz | cut -f1 -d " "
      WINDOWS32_SIZE:
        sh: ls -la {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_Windows_32bit.zip | cut -f5 -d " "
      WINDOWS64_SIZE:
        sh: ls -la {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_Windows_64bit.zip | cut -f5 -d " "
      LINUX32_SIZE:
        sh: ls -la {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_Linux_32bit.tar.gz | cut -f5 -d " "
      LINUX64_SIZE:
        sh: ls -la {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_Linux_64bit.tar.gz | cut -f5 -d " "
      LINUXARM_SIZE:
        sh: ls -la {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_Linux_ARMv6.tar.gz | cut -f5 -d " "
      LINUXARM64_SIZE:
        sh: ls -la {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_Linux_ARM64.tar.gz | cut -f5 -d " "
      OSX64_SIZE:
        sh: ls -la {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_macOS_64bit.tar.gz | cut -f5 -d " "
      OSXARM64_SIZE:
        sh: ls -la {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_macOS_ARM64.tar.gz | cut -f5 -d " "
    cmds:
      - |
        cat extras/package_index.json.template |
        sed "s/%%VERSION%%/{{ .VERSION }}/" |
        sed "s/%%FILENAME%%/{{ .PROJECT_NAME }}/" |
        sed "s/%%LINUX64_SHA%%/{{ .LINUX64_SHA }}/" |
        sed "s/%%LINUX64_SIZE%%/{{ .LINUX64_SIZE }}/" |
        sed "s/%%LINUX32_SHA%%/{{ .LINUX32_SHA }}/" |
        sed "s/%%LINUX32_SIZE%%/{{ .LINUX32_SIZE }}/" |
        sed "s/%%LINUXARM_SHA%%/{{ .LINUXARM_SHA }}/" |
        sed "s/%%LINUXARM_SIZE%%/{{ .LINUXARM_SIZE }}/" |
        sed "s/%%LINUXARM64_SHA%%/{{ .LINUXARM64_SHA }}/" |
        sed "s/%%LINUXARM64_SIZE%%/{{ .LINUXARM64_SIZE }}/" |
        sed "s/%%OSX64_SHA%%/{{ .OSX64_SHA }}/" |
        sed "s/%%OSX64_SIZE%%/{{ .OSX64_SIZE }}/" |
        sed "s/%%OSXARM64_SHA%%/{{ .OSXARM64_SHA }}/" |
        sed "s/%%OSXARM64_SIZE%%/{{ .OSXARM64_SIZE }}/" |
        sed "s/%%WINDOWS32_SHA%%/{{ .WINDOWS32_SHA }}/" |
        sed "s/%%WINDOWS32_SIZE%%/{{ .WINDOWS32_SIZE }}/" |
        sed "s/%%WINDOWS64_SHA%%/{{ .WINDOWS64_SHA }}/" |
        sed "s/%%WINDOWS64_SIZE%%/{{ .WINDOWS64_SIZE }}/" \
        > {{ .DIST_DIR }}/package_index.json