Merge pull request #87 from arduino/gh-workflows

cmaglie · web-flow · commit cba46f836bf7 · 2021-11-23T15:31:31.000+01:00
Added gh-action workflows and build tasks
diff --git a/.github/workflows/release-go-task.yml b/.github/workflows/release-go-task.yml
@@ -0,0 +1,90 @@
+# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/release-go-task.md
+name: Release
+
+env:
+  # As defined by the Taskfile's PROJECT_NAME variable
+  PROJECT_NAME: arduino-language-server
+  # As defined by the Taskfile's DIST_DIR variable
+  DIST_DIR: dist
+  # The project's folder on Arduino's download server for uploading builds
+  AWS_PLUGIN_TARGET: /arduino-language-server/
+  ARTIFACT_NAME: dist
+
+on:
+  push:
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+*"
+
+jobs:
+  create-release-artifacts:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Create changelog
+        uses: arduino/create-changelog@v1
+        with:
+          tag-regex: '^[0-9]+\.[0-9]+\.[0-9]+.*$'
+          filter-regex: '^\[(skip|changelog)[ ,-](skip|changelog)\].*'
+          case-insensitive-regex: true
+          changelog-file-path: "${{ env.DIST_DIR }}/CHANGELOG.md"
+
+      - name: Install Task
+        uses: arduino/setup-task@v1
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          version: 3.x
+
+      - name: Build
+        run: task dist:all
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v2
+        with:
+          if-no-files-found: error
+          name: ${{ env.ARTIFACT_NAME }}
+          path: ${{ env.DIST_DIR }}
+
+  create-release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Download artifact
+        uses: actions/download-artifact@v2
+        with:
+          name: ${{ env.ARTIFACT_NAME }}
+          path: ${{ env.DIST_DIR }}
+
+      - name: Identify Prerelease
+        # This is a workaround while waiting for create-release action
+        # to implement auto pre-release based on tag
+        id: prerelease
+        run: |
+          wget -q -P /tmp https://github.com/fsaintjacques/semver-tool/archive/3.0.0.zip
+          unzip -p /tmp/3.0.0.zip semver-tool-3.0.0/src/semver >/tmp/semver && chmod +x /tmp/semver
+          if [[ "$(/tmp/semver get prerel "${GITHUB_REF/refs\/tags\//}")" ]]; then echo "::set-output name=IS_PRE::true"; fi
+
+      - name: Create Github Release and upload artifacts
+        uses: ncipollo/release-action@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          bodyFile: ${{ env.DIST_DIR }}/CHANGELOG.md
+          draft: false
+          prerelease: ${{ steps.prerelease.outputs.IS_PRE }}
+          # NOTE: "Artifact is a directory" warnings are expected and don't indicate a problem
+          # (all the files we need are in the DIST_DIR root)
+          artifacts: ${{ env.DIST_DIR }}/*
+
+      - name: Upload release files on Arduino downloads servers
+        uses: docker://plugins/s3
+        env:
+          PLUGIN_SOURCE: "${{ env.DIST_DIR }}/*"
+          PLUGIN_TARGET: ${{ env.AWS_PLUGIN_TARGET }}
+          PLUGIN_STRIP_PREFIX: "${{ env.DIST_DIR }}/"
+          PLUGIN_BUCKET: ${{ secrets.DOWNLOADS_BUCKET }}
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
diff --git a/DistTasks.yml b/DistTasks.yml
@@ -0,0 +1,253 @@
+# 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.16.4"
+  CHECKSUM_FILE: "{{.VERSION}}-checksums.txt"
+
+tasks:
+  all:
+    desc: Build for distribution for all platforms
+    cmds:
+      - task: Windows_32bit
+      - task: Windows_64bit
+      - task: Linux_32bit
+      - task: Linux_64bit
+      - task: Linux_ARMv6
+      - task: Linux_ARMv7
+      - task: Linux_ARM64
+      - task: macOS_64bit
+
+  Windows_32bit:
+    desc: Builds Windows 32 bit binaries
+    dir: "{{.DIST_DIR}}"
+    cmds:
+      - |
+        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 ../LICENSE.txt -j
+        sha256sum {{.PACKAGE_NAME}} >> {{.CHECKSUM_FILE}}
+
+    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:
+      - |
+        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 ../LICENSE.txt -j
+        sha256sum {{.PACKAGE_NAME}} >> {{.CHECKSUM_FILE}}
+
+    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:
+      - |
+        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 -C {{.PLATFORM_DIR}} {{.PROJECT_NAME}} -C ../.. LICENSE.txt  -f {{.PACKAGE_NAME}}
+        sha256sum {{.PACKAGE_NAME}} >> {{.CHECKSUM_FILE}}
+
+    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:
+      - |
+        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 -C {{.PLATFORM_DIR}} {{.PROJECT_NAME}} -C ../.. LICENSE.txt  -f {{.PACKAGE_NAME}}
+        sha256sum {{.PACKAGE_NAME}} >> {{.CHECKSUM_FILE}}
+
+    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:
+      - |
+        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 -C {{.PLATFORM_DIR}} {{.PROJECT_NAME}} -C ../.. LICENSE.txt  -f {{.PACKAGE_NAME}}
+        sha256sum {{.PACKAGE_NAME}} >> {{.CHECKSUM_FILE}}
+
+    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:
+      - |
+        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 -C {{.PLATFORM_DIR}} {{.PROJECT_NAME}} -C ../.. LICENSE.txt  -f {{.PACKAGE_NAME}}
+        sha256sum {{.PACKAGE_NAME}} >> {{.CHECKSUM_FILE}}
+
+    vars:
+      PLATFORM_DIR: "{{.PROJECT_NAME}}_linux_arm_6"
+      BUILD_COMMAND: "go build -o {{.DIST_DIR}}/{{.PLATFORM_DIR}}/{{.PROJECT_NAME}} {{.LDFLAGS}}"
+      BUILD_PLATFORM: "linux/armv6"
+      # We are experiencing the following error with ARMv6 build:
+      #
+      #   # github.com/arduino/arduino-cli
+      #   net(.text): unexpected relocation type 296 (R_ARM_V4BX)
+      #   panic: runtime error: invalid memory address or nil pointer dereference
+      #   [signal SIGSEGV: segmentation violation code=0x1 addr=0x0 pc=0x51ae53]
+      #
+      #   goroutine 1 [running]:
+      #   cmd/link/internal/loader.(*Loader).SymName(0xc000095c00, 0x0, 0xc0000958d8, 0x5a0ac)
+      #           /usr/local/go/src/cmd/link/internal/loader/loader.go:684 +0x53
+      #   cmd/link/internal/ld.dynrelocsym2(0xc000095880, 0x5a0ac)
+      #           /usr/local/go/src/cmd/link/internal/ld/data.go:777 +0x295
+      #   cmd/link/internal/ld.(*dodataState).dynreloc2(0xc007df9800, 0xc000095880)
+      #           /usr/local/go/src/cmd/link/internal/ld/data.go:794 +0x89
+      #   cmd/link/internal/ld.(*Link).dodata2(0xc000095880, 0xc007d00000, 0x60518, 0x60518)
+      #           /usr/local/go/src/cmd/link/internal/ld/data.go:1434 +0x4d4
+      #   cmd/link/internal/ld.Main(0x8729a0, 0x4, 0x8, 0x1, 0xd, 0xe, 0x0, 0x0, 0x6d7737, 0x12, ...)
+      #           /usr/local/go/src/cmd/link/internal/ld/main.go:302 +0x123a
+      #   main.main()
+      #           /usr/local/go/src/cmd/link/main.go:68 +0x1dc
+      #   Error: failed building for linux/armv6: exit status 2
+      #
+      # This seems to be a problem in the go builder 1.16.x that removed support for the R_ARM_V4BX instruction:
+      #    https://github.com/golang/go/pull/44998
+      #    https://groups.google.com/g/golang-codereviews/c/yzN80xxwu2E
+      #
+      # Until there is a fix released we must use a recent gcc for Linux_ARMv6 build, so for this
+      # build we select the debian10 based container.
+      CONTAINER_TAG: "{{.GO_VERSION}}-armel-debian10"
+      PACKAGE_PLATFORM: "Linux_ARMv6"
+      PACKAGE_NAME: "{{.PROJECT_NAME}}_{{.VERSION}}_{{.PACKAGE_PLATFORM}}.tar.gz"
+
+  Linux_ARM64:
+    desc: Builds Linux ARM64 binaries
+    dir: "{{.DIST_DIR}}"
+    cmds:
+      - |
+        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 -C {{.PLATFORM_DIR}} {{.PROJECT_NAME}} -C ../.. LICENSE.txt  -f {{.PACKAGE_NAME}}
+        sha256sum {{.PACKAGE_NAME}} >> {{.CHECKSUM_FILE}}
+
+    vars:
+      PLATFORM_DIR: "{{.PROJECT_NAME}}_linux_arm_6"
+      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:
+      - |
+        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 -C {{.PLATFORM_DIR}} {{.PROJECT_NAME}} -C ../.. LICENSE.txt  -f {{.PACKAGE_NAME}}
+        sha256sum {{.PACKAGE_NAME}} >> {{.CHECKSUM_FILE}}
+
+    vars:
+      PLATFORM_DIR: "{{.PROJECT_NAME}}_osx_darwin_amd64"
+      BUILD_COMMAND: "go build -o {{.DIST_DIR}}/{{.PLATFORM_DIR}}/{{.PROJECT_NAME}} {{.LDFLAGS}}"
+      BUILD_PLATFORM: "darwin/amd64"
+      # We are experiencing the following error with macOS_64bit build:
+      #
+      #   Undefined symbols for architecture x86_64:
+      #     "_clock_gettime", referenced from:
+      #         _runtime.walltime_trampoline in go.o
+      #   ld: symbol(s) not found for architecture x86_64
+      #   clang: error: linker command failed with exit code 1 (use -v to see invocation)
+      #
+      # The reason seems that go 1.16.x use a macos API which is available since 10.12
+      #    https://github.com/techknowlogick/xgo/issues/100#issuecomment-780894190
+      #
+      # To compile it we need an SDK >=10.12 so we use the debian10 based container that
+      # has the SDK 10.14 installed.
+      CONTAINER_TAG: "{{.GO_VERSION}}-darwin-debian10"
+      PACKAGE_PLATFORM: "macOS_64bit"
+      PACKAGE_NAME: "{{.PROJECT_NAME}}_{{.VERSION}}_{{.PACKAGE_PLATFORM}}.tar.gz"
diff --git a/Taskfile.yml b/Taskfile.yml

-Original file line number
+Diff line change
@@ @@ -0,0 +1,358 @@ @@
 +version: "3"
++
 +includes:
 +  dist: ./DistTasks.yml
++
 +tasks:
 +  docs:generate:
 +    desc: Create all generated documentation content
 +    deps:
 +      - task: go:cli-docs
 +      - task: protoc:docs
 +    cmds:
 +      - task: general:format-prettier
++
 +  # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-dependencies-task/Taskfile.yml
 +  general:cache-dep-licenses:
 +    desc: Cache dependency license metadata
 +    cmds:
 +      - |
 +        if ! which licensed &>/dev/null; then
 +          if [[ {{OS}} == "windows" ]]; then
 +            echo "Licensed does not have Windows support."
 +            echo "Please use Linux/macOS or download the dependencies cache from the GitHub Actions workflow artifact."
 +          else
 +            echo "licensed not found or not in PATH. Please install: https://github.com/github/licensed#as-an-executable"
 +          fi
 +          exit 1
 +        fi
 +      - licensed cache
++
 +  # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-dependencies-task/Taskfile.yml
 +  general:check-dep-licenses:
 +    desc: Check for unapproved dependency licenses
 +    deps:
 +      - task: general:cache-dep-licenses
 +    cmds:
 +      - licensed status
++
 +  # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-prettier-formatting-task/Taskfile.yml
 +  general:format-prettier:
 +    desc: Format all supported files with Prettier
 +    cmds:
 +      - npx prettier --write .
++
 +  # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/go-task/Taskfile.yml
 +  go:build:
 +    desc: Build the Go code
 +    dir: '{{default "./" .GO_MODULE_PATH}}'
 +    cmds:
 +      - go build -v {{.LDFLAGS}}
++
 +  # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/deploy-cobra-mkdocs-versioned-poetry/Taskfile.yml
 +  go:cli-docs:
 +    desc: Generate command line interface reference documentation
 +    dir: ./docsgen
 +    cmds:
 +      # Command examples use os.Args[0] so the docs generation binary must have the same filename as the project
 +      - go build -o {{.PROJECT_NAME}}{{exeExt}}
 +      # The binary is invoked like this instead of `./{{.PROJECT_NAME}}` to remove the `./` chars from the examples
 +      - PATH=. {{.PROJECT_NAME}} ../docs/commands
++
 +  # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-go-task/Taskfile.yml
 +  go:fix:
 +    desc: Modernize usages of outdated APIs
 +    dir: '{{default "./" .GO_MODULE_PATH}}'
 +    cmds:
 +      - go fix {{default .DEFAULT_GO_PACKAGES .GO_PACKAGES}}
++
 +  # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-go-task/Taskfile.yml
 +  go:format:
 +    desc: Format Go code
 +    dir: '{{default "./" .GO_MODULE_PATH}}'
 +    cmds:
 +      - go fmt {{default .DEFAULT_GO_PACKAGES .GO_PACKAGES}}
++
 +  # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-go-task/Taskfile.yml
 +  go:lint:
 +    desc: Lint Go code
 +    dir: '{{default "./" .GO_MODULE_PATH}}'
 +    cmds:
 +      - |
 +        if ! which golint &>/dev/null; then
 +          echo "golint not installed or not in PATH. Please install: https://github.com/golang/lint#installation"
 +          exit 1
 +        fi
 +      - |
 +        golint \
 +          {{default "-min_confidence 0.8 -set_exit_status" .GO_LINT_FLAGS}} \
 +          {{default .DEFAULT_GO_PACKAGES .GO_PACKAGES}}
++
 +  # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/test-go-task/Taskfile.yml
 +  go:test:
 +    desc: Run unit tests
 +    dir: '{{default "./" .GO_MODULE_PATH}}'
 +    cmds:
 +      - |
 +        go test \
 +          -v \
 +          -short \
 +          -run '{{default ".*" .GO_TEST_REGEX}}' \
 +          {{default "-timeout 10m -coverpkg=./... -covermode=atomic" .GO_TEST_FLAGS}} \
 +          -coverprofile=coverage_unit.txt \
 +          {{default .DEFAULT_GO_PACKAGES .GO_PACKAGES}} \
 +          {{.TEST_LDFLAGS}}
++
 +  # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/test-go-integration-task/Taskfile.yml
 +  go:test-integration:
 +    desc: Run integration tests
 +    deps:
 +      - task: go:build
 +      - task: poetry:install-deps
 +    cmds:
 +      - poetry run pytest test
++
 +  # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-go-task/Taskfile.yml
 +  go:vet:
 +    desc: Check for errors in Go code
 +    dir: '{{default "./" .GO_MODULE_PATH}}'
 +    cmds:
 +      - go vet {{default .DEFAULT_GO_PACKAGES .GO_PACKAGES}}
++
 +  # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-markdown-task/Taskfile.yml
 +  markdown:check-links:
 +    desc: Check for broken links
 +    deps:
 +      - task: docs:generate
 +    cmds:
 +      - |
 +        if [[ "{{.OS}}" == "Windows_NT" ]]; then
 +          # npx --call uses the native shell, which makes it too difficult to use npx for this application on Windows,
 +          # so the Windows user is required to have markdown-link-check installed and in PATH.
 +          if ! which markdown-link-check &>/dev/null; then
 +            echo "markdown-link-check not found or not in PATH. Please install: https://github.com/tcort/markdown-link-check#readme"
 +            exit 1
 +          fi
 +          # Default behavior of the task on Windows is to exit the task when the first broken link causes a non-zero
 +          # exit status, but it's better to check all links before exiting.
 +          set +o errexit
 +          STATUS=0
 +          # Using -regex instead of -name to avoid Task's behavior of globbing even when quoted on Windows
 +          # The odd method for escaping . in the regex is required for windows compatibility because mvdan.cc/sh gives
 +          # \ characters special treatment on Windows in an attempt to support them as path separators.
 +          for file in $(find . -regex ".*[.]md"); do
 +            markdown-link-check \
 +              --quiet \
 +              --config "./.markdown-link-check.json" \
 +              "$file"
 +            STATUS=$(( $STATUS + $? ))
 +          done
 +          exit $STATUS
 +        else
 +          npx --package=markdown-link-check --call='
 +            STATUS=0
 +            for file in $(find . -regex ".*[.]md"); do
 +              markdown-link-check \
 +                --quiet \
 +                --config "./.markdown-link-check.json" \
 +                "$file"
 +              STATUS=$(( $STATUS + $? ))
 +            done
 +            exit $STATUS
 +          '
 +        fi
++
 +  # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-markdown-task/Taskfile.yml
 +  markdown:fix:
 +    desc: Automatically correct linting violations in Markdown files where possible
 +    cmds:
 +      - npx markdownlint-cli --fix "**/*.md"
++
 +  # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-markdown-task/Taskfile.yml
 +  markdown:lint:
 +    desc: Check for problems in Markdown files
 +    cmds:
 +      - npx markdownlint-cli "**/*.md"
++
 +  # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/poetry-task/Taskfile.yml
 +  poetry:install-deps:
 +    desc: Install dependencies managed by Poetry
 +    cmds:
 +      - poetry install --no-root
++
 +  protoc:
 +    desc: Lint, format and compile protobuf definitions
 +    deps:
 +      - protoc:check
 +      - protoc:format
 +      - protoc:compile
++
 +  protoc:compile:
 +    desc: Compile protobuf definitions
 +    cmds:
 +      - '{{ default "protoc" .PROTOC_BINARY }} --proto_path=rpc --go_out=./rpc --go_opt=paths=source_relative --go-grpc_out=./rpc --go-grpc_opt=paths=source_relative ./rpc/cc/arduino/cli/commands/v1/*.proto'
 +      - '{{ default "protoc" .PROTOC_BINARY }} --proto_path=rpc --go_out=./rpc --go_opt=paths=source_relative --go-grpc_out=./rpc --go-grpc_opt=paths=source_relative ./rpc/cc/arduino/cli/monitor/v1/*.proto'
 +      - '{{ default "protoc" .PROTOC_BINARY }} --proto_path=rpc --go_out=./rpc --go_opt=paths=source_relative --go-grpc_out=./rpc --go-grpc_opt=paths=source_relative ./rpc/cc/arduino/cli/settings/v1/*.proto'
 +      - '{{ default "protoc" .PROTOC_BINARY }} --proto_path=rpc --go_out=./rpc --go_opt=paths=source_relative --go-grpc_out=./rpc --go-grpc_opt=paths=source_relative ./rpc/cc/arduino/cli/debug/v1/*.proto'
++
 +  protoc:docs:
 +    desc: Generate docs for protobuf definitions
 +    cmds:
 +      - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,commands.md --proto_path=rpc ./rpc/cc/arduino/cli/commands/v1/*.proto'
 +      - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,monitor.md --proto_path=rpc ./rpc/cc/arduino/cli/monitor/v1/*.proto'
 +      - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,settings.md --proto_path=rpc ./rpc/cc/arduino/cli/settings/v1/*.proto'
 +      - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,debug.md --proto_path=rpc ./rpc/cc/arduino/cli/debug/v1/*.proto'
++
 +  protoc:check:
 +    desc: Perform linting of the protobuf definitions
 +    cmds:
 +      - buf lint rpc
++
 +  protoc:format:
 +    desc: Perform formatting of the protobuf definitions
 +    cmds:
 +      - clang-format -i rpc/cc/arduino/cli/*/*/*.proto
++
 +  # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-python-task/Taskfile.yml
 +  python:format:
 +    desc: Format Python files
 +    deps:
 +      - task: poetry:install-deps
 +    cmds:
 +      - poetry run black .
++
 +  # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-python-task/Taskfile.yml
 +  python:lint:
 +    desc: Lint Python code
 +    deps:
 +      - task: poetry:install-deps
 +    cmds:
 +      - poetry run flake8 --show-source
++
 +  build:
 +    desc: Build the project
 +    deps:
 +      - task: go:build
++
 +  test:
 +    desc: Run the full testsuite, `legacy` will be skipped
 +    cmds:
 +      - task: go:test
 +      - task: go:test-integration
++
 +  test-legacy:
 +    desc: Run tests for the `legacy` package
 +    cmds:
 +      - |
 +        go test \
 +          {{ default "-v -failfast" .GOFLAGS }} \
 +          -coverprofile=coverage_legacy.txt \
 +          ./legacy/... \
 +          {{.TEST_LDFLAGS}}
++
 +  test-unit-race:
 +    desc: Run unit tests only with race condition detection
 +    cmds:
 +      - |
 +        go test \
 +          -short \
 +          -race {{ default "-v" .GOFLAGS }} \
 +          -coverprofile=coverage_race_unit.txt \
 +          {{ default .DEFAULT_GO_PACKAGES .TARGETS }} \
 +          {{.TEST_LDFLAGS}}
++
 +  check:
 +    desc: Check fmt and lint, `legacy` will be skipped
 +    cmds:
 +      - task: go:vet
 +      - task: go:lint
 +      - task: i18n:check
 +      - task: python:lint
 +      - task: protoc:check
++
 +  check-legacy:
 +    desc: Check fmt and lint for the `legacy` package
 +    cmds:
 +      - test -z $(go fmt ./legacy/...)
 +      - go vet ./legacy/...
++
 +  rpc-client:
 +    desc: Run the rpc client test routine (server must be already started)
 +    cmds:
 +      - go test -run TestWithClientE2E ./commands/daemon
++
 +  i18n:update:
 +    desc: Updates i18n files
 +    cmds:
 +      - go run ./i18n/cmd/main.go catalog generate . > ./i18n/data/en.po
++
 +  i18n:pull:
 +    desc: Pull i18n files from transifex
 +    cmds:
 +      - go run ./i18n/cmd/main.go transifex pull ./i18n/data
++
 +  i18n:push:
 +    desc: Push i18n files to transifex
 +    cmds:
 +      - go run ./i18n/cmd/main.go transifex push ./i18n/data
++
 +  i18n:check:
 +    desc: Check if the i18n message catalog was updated
 +    cmds:
 +      - task: i18n:update
 +      - git add -N ./i18n/data
 +      - git diff --exit-code ./i18n/data
++
 +  # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-mkdocs-task/Taskfile.yml
 +  website:check:
 +    desc: Check whether the MkDocs-based website will build
 +    deps:
 +      - task: docs:generate
 +      - task: poetry:install-deps
 +    cmds:
 +      - poetry run mkdocs build --strict
++
 +  # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-mkdocs-task/Taskfile.yml
 +  website:serve:
 +    desc: Run website locally
 +    deps:
 +      - task: docs:generate
 +      - task: poetry:install-deps
 +    cmds:
 +      - poetry run mkdocs serve
++
 +vars:
 +  PROJECT_NAME: "arduino-language-server"
 +  DIST_DIR: "dist"
 +  DEFAULT_GO_PACKAGES:
 +    sh: |
 +      echo $(cd {{default "./" .GO_MODULE_PATH}} && go list ./... | tr '\n' ' ' || echo '"ERROR: Unable to discover Go packages"')
 +  # build vars
 +  COMMIT:
 +    sh: echo "$(git log --no-show-signature -n 1 --format=%h)"
 +  TIMESTAMP:
 +    sh: echo "$(date -u +"%Y-%m-%dT%H:%M:%SZ")"
 +  TIMESTAMP_SHORT:
 +    sh: echo "{{now | date "20060102"}}"
 +  TAG:
 +    sh: echo "$(git tag --points-at=HEAD 2> /dev/null | head -n1)"
 +  VERSION: "{{if .NIGHTLY}}nightly-{{.TIMESTAMP_SHORT}}{{else if .TAG}}{{.TAG}}{{else}}{{.PACKAGE_NAME_PREFIX}}git-snapshot{{end}}"
 +  CONFIGURATION_PACKAGE: "github.com/arduino/arduino-language-server/version"
 +  LDFLAGS: >-
 +    -ldflags
 +    '
 +    -X {{.CONFIGURATION_PACKAGE}}.versionString={{.VERSION}}
 +    -X {{.CONFIGURATION_PACKAGE}}.commit={{.COMMIT}}
 +    -X {{.CONFIGURATION_PACKAGE}}.date={{.TIMESTAMP}}
 +    '
 +  # test vars
 +  GOFLAGS: "-timeout 10m -v -coverpkg=./... -covermode=atomic"
 +  TEST_VERSION: "0.0.0-test.preview"
 +  TEST_COMMIT: "deadbeef"
 +  TEST_LDFLAGS: >-
 +    -ldflags
 +    '
 +    -X {{.CONFIGURATION_PACKAGE}}.versionString={{.TEST_VERSION}}
 +    -X {{.CONFIGURATION_PACKAGE}}.commit={{.TEST_COMMIT}}
 +    -X {{.CONFIGURATION_PACKAGE}}.date={{.TIMESTAMP}}
 +    '