chore: use scripts + TMC sync in CI tests.

Signed-off-by: i4k <[email protected]>

.github/workflows/ci.yml

@@ -11,48 +11,43 @@ on:
   pull_request:
 
 jobs:
-  checks:
-    runs-on: ubuntu-20.04
-
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - uses: actions/setup-go@v4
-        with:
-          go-version: '1.21'
-
-      - name: build Terramate
-        run: make build
-
-      - name: checking go mod tidyness
-        run: ./bin/terramate run --tags golang --changed -- make mod/check
-
-      - name: linting code
-        run: ./bin/terramate run --tags golang --changed -- make lint
-
-      - name: checking license on source code
-        run: ./bin/terramate run --tags golang --changed -- make license/check
-
   build_test:
     name: Build and Test
-    runs-on: ${{ matrix.os }}
+    runs-on: ${{ matrix.os.value }}
+
     permissions:
       id-token: write # This is required for requesting the JWT
       contents: read  # This is required for actions/checkout
+      pull-requests: write
+      checks: read
 
     strategy:
+      fail-fast: false
       matrix:
-        os: ["ubuntu-20.04", "macos-13"]
+        os:
+          - name: ubuntu-focal
+            value: "ubuntu-20.04"
+          - name: macos-ventura
+            value: "macos-13"
         go: ["1.21"]
 
     steps:
+      - name: Prepare pull request comment
+        if: github.event.pull_request
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          header: preview-${{ matrix.os.name }}-go-${{matrix.go}}
+          message: |
+            ## Preview of ${{ matrix.os.name }}/go${{matrix.go}} tests in ${{ github.event.pull_request.head.sha }}
+
+            :warning: being created... please stand by!
+
       - uses: actions/checkout@v4
         with:
           ref: ${{ github.head_ref }}
           fetch-depth: 0
-
+    
       - uses: actions/setup-go@v5
         with:
           go-version: ${{ matrix.go }}
@@ -63,20 +58,109 @@ jobs:
           tofu_wrapper: false
           github_token: ${{ secrets.GITHUB_TOKEN }}
 
+      - uses: hashicorp/setup-terraform@v3
+        with:
+          terraform_version: "1.7.5"
+
+      - name: Install Terramate
+        uses: terramate-io/terramate-action@i4k-fix-macos
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
       - name: build Terramate
-        run: make build
+        run: make build && cp -v ./bin/terramate /usr/local/bin/terramate-bin
 
       - name: make generate
         run: make generate
 
-      - name: make test
+      ### Check for changed stacks
+
+      - name: List changed stacks
+        id: list
+        run: terramate list --tags golang --changed
+
+      ### Linting
+
+      - name: linting code
+        if: steps.list.outputs.stdout
+        run: make lint
+
+      - name: checking go mod tidyness
+        if: steps.list.outputs.stdout
+        run: make mod/check
+
+      - name: checking license on source code
+        if: steps.list.outputs.stdout
+        run: make license/check
+
+      - name: Check Terramate formatting
+        run: terramate fmt --check
+
+      - name: Check Terraform formatting
+        if: steps.list.outputs.stdout
+        run: terraform fmt -recursive -check -diff
+
+      ### Run the Terramate tests and create a Cloud Preview
+
+      - name: Temporary PR Preview Link generation
+        run: echo >preview_url.txt "https://cloud.terramate.io/o/terramate/review-requests"
+
+      - name: Run Terraform preview on changed
+        if: steps.list.outputs.stdout
         timeout-minutes: 30
-        run: ./bin/terramate run --tags golang --changed -- make test
+        run: terramate script run --tags golang --target ${{ matrix.os.name }} --parallel 12 --changed preview
         env:
+          GITHUB_TOKEN: ${{ github.token }}
           TM_TEST_TERRAFORM_REQUIRED_VERSION: "1.7.5"
 
-      - name: check cloud info
-        run: ./bin/terramate run --tags golang --changed -- ./bin/terramate -vv experimental cloud info
+      ### Update Pull Request comment
+
+      - name: Generate Preview Comment
+        if: steps.list.outputs.stdout
+        id: comment
+        run: |
+          echo >>pr-comment.txt "## Preview of ${{ matrix.os.name }}/go${{matrix.go}} tests in ${{ github.event.pull_request.head.sha }}"
+          echo >>pr-comment.txt
+          echo >>pr-comment.txt "[:mag: View Details on Terramate Cloud]($(cat preview_url.txt))"
+          echo >>pr-comment.txt
+          echo >>pr-comment.txt "### Changed Stacks"
+          echo >>pr-comment.txt
+          echo >>pr-comment.txt '```bash'
+          echo >>pr-comment.txt "${{ steps.list.outputs.stdout }}"
+          echo >>pr-comment.txt '```'
+          cat pr-comment.txt >>$GITHUB_STEP_SUMMARY
+
+      - name: Inform about no Changed Stacks
+        if: success() && !steps.list.outputs.stdout
+        run: |
+          echo >>pr-comment.txt "## Preview of ${{ matrix.os.name }}/go${{matrix.go}} tests in ${{ github.event.pull_request.head.sha }}"
+          echo >>pr-comment.txt
+          echo >>pr-comment.txt "### Changed Stacks"
+          echo >>pr-comment.txt
+          echo >>pr-comment.txt 'No changed stacks, no detailed preview will be generated.'
+          cat pr-comment.txt >>$GITHUB_STEP_SUMMARY
+
+      - name: Inform about failure
+        if: failure()
+        run: |
+          echo >>pr-comment.txt "## Preview of ${{ matrix.os.name }}/go${{matrix.go}} tests in ${{ github.event.pull_request.head.sha }}"
+          echo >>pr-comment.txt
+          echo >>pr-comment.txt "[:mag: View Details on Terramate Cloud]($(cat preview_url.txt))"
+          echo >>pr-comment.txt
+          echo >>pr-comment.txt "### Changed Stacks"
+          echo >>pr-comment.txt
+          echo >>pr-comment.txt '```bash'
+          echo >>pr-comment.txt "${{ steps.list.outputs.stdout }}"
+          echo >>pr-comment.txt '```'
+          echo >>pr-comment.txt ":boom: Generating preview failed. [Please see details on Terramate Cloud]($(cat preview_url.txt))"
+          cat pr-comment.txt >>$GITHUB_STEP_SUMMARY
+
+      - name: Publish Plans for Changed Stacks
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          header: preview-${{ matrix.os.name }}-go-${{matrix.go}}
+          path: pr-comment.txt
 
   gh_integration_test:
     name: GHA Integration Test
@@ -98,7 +182,7 @@ jobs:
         run: make build
 
       - name: make test/ci
-        run: ./bin/terramate run --tags golang --changed -- make test/ci
+        run: make test/ci
 
   release_dry_run:
     name: Release Dry Run
@@ -158,7 +242,6 @@ jobs:
           cosign verify-blob --key cosign.pub --signature ${{ env.SIGNATURE_FILE }} ${{ env.CHECKSUM_FILE }}       
   ci:
     needs:
-      - checks
       - build_test
       - gh_integration_test
     runs-on: ubuntu-20.04

.gitignore

@@ -9,6 +9,7 @@ coverage.txt
 cpu.prof
 mem.prof
 *.test
+*.tfplan
 *.plan
 
 # Go Workspaces artifacts

_test_mock.tf

@@ -0,0 +1,6 @@
+// TERRAMATE: GENERATED AUTOMATICALLY DO NOT EDIT
+
+resource "local_file" "foo" {
+  content  = "terramate"
+  filename = "${path.module}/mock.ignore"
+}

cloud/_test_mock.tf

@@ -0,0 +1,6 @@
+// TERRAMATE: GENERATED AUTOMATICALLY DO NOT EDIT
+
+resource "local_file" "foo" {
+  content  = "package cloud // import \"github.com/terramate-io/terramate/cloud\""
+  filename = "${path.module}/mock.ignore"
+}

cloud/deployment/_test_mock.tf

@@ -0,0 +1,6 @@
+// TERRAMATE: GENERATED AUTOMATICALLY DO NOT EDIT
+
+resource "local_file" "foo" {
+  content  = "package deployment // import \"github.com/terramate-io/terramate/cloud/deployment\""
+  filename = "${path.module}/mock.ignore"
+}

cloud/deployment/stack.tm.hcl

@@ -0,0 +1,9 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+stack {
+  name        = "package deployment // import \"github.com/terramate-io/terramate/cloud/deployment\""
+  description = "package deployment // import \"github.com/terramate-io/terramate/cloud/deployment\""
+  tags        = ["cloud", "deployment", "golang"]
+  id          = "8f7fced1-1649-4c71-bdb1-5d861141a953"
+}

cloud/drift/_test_mock.tf

@@ -0,0 +1,6 @@
+// TERRAMATE: GENERATED AUTOMATICALLY DO NOT EDIT
+
+resource "local_file" "foo" {
+  content  = "package drift // import \"github.com/terramate-io/terramate/cloud/drift\""
+  filename = "${path.module}/mock.ignore"
+}

cloud/drift/stack.tm.hcl

@@ -0,0 +1,9 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+stack {
+  name        = "package drift // import \"github.com/terramate-io/terramate/cloud/drift\""
+  description = "package drift // import \"github.com/terramate-io/terramate/cloud/drift\""
+  tags        = ["cloud", "drift", "golang"]
+  id          = "feadf9e7-6cee-4f5e-9f75-a91c98ce4679"
+}

cloud/preview/_test_mock.tf

@@ -0,0 +1,6 @@
+// TERRAMATE: GENERATED AUTOMATICALLY DO NOT EDIT
+
+resource "local_file" "foo" {
+  content  = "package preview // import \"github.com/terramate-io/terramate/cloud/preview\""
+  filename = "${path.module}/mock.ignore"
+}

cloud/preview/stack.tm.hcl

@@ -0,0 +1,9 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+stack {
+  name        = "package preview // import \"github.com/terramate-io/terramate/cloud/preview\""
+  description = "package preview // import \"github.com/terramate-io/terramate/cloud/preview\""
+  tags        = ["cloud", "golang", "preview"]
+  id          = "90d86bc8-5cac-4576-9241-cfa9f9adc93d"
+}

cloud/stack.tm.hcl

@@ -0,0 +1,9 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+stack {
+  name        = "package cloud // import \"github.com/terramate-io/terramate/cloud\""
+  description = "package cloud // import \"github.com/terramate-io/terramate/cloud\""
+  tags        = ["cloud", "golang"]
+  id          = "1d457835-4401-4ed9-bbbf-d4676c0e9b0c"
+}

cloud/stack/_test_mock.tf

@@ -0,0 +1,6 @@
+// TERRAMATE: GENERATED AUTOMATICALLY DO NOT EDIT
+
+resource "local_file" "foo" {
+  content  = "package stack // import \"github.com/terramate-io/terramate/cloud/stack\""
+  filename = "${path.module}/mock.ignore"
+}

cloud/stack/stack.tm.hcl

@@ -0,0 +1,9 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+stack {
+  name        = "package stack // import \"github.com/terramate-io/terramate/cloud/stack\""
+  description = "package stack // import \"github.com/terramate-io/terramate/cloud/stack\""
+  tags        = ["cloud", "golang", "stack"]
+  id          = "6b9cce64-2b44-43ed-bb2c-dc9525dd2585"
+}

cloud/testserver/_test_mock.tf

@@ -0,0 +1,6 @@
+// TERRAMATE: GENERATED AUTOMATICALLY DO NOT EDIT
+
+resource "local_file" "foo" {
+  content  = "package testserver // import \"github.com/terramate-io/terramate/cloud/testserver\""
+  filename = "${path.module}/mock.ignore"
+}

cloud/testserver/cloudstore/_test_mock.tf

@@ -0,0 +1,6 @@
+// TERRAMATE: GENERATED AUTOMATICALLY DO NOT EDIT
+
+resource "local_file" "foo" {
+  content  = "package cloudstore // import \"github.com/terramate-io/terramate/cloud/testserver/cloudstore\""
+  filename = "${path.module}/mock.ignore"
+}

cloud/testserver/cloudstore/stack.tm.hcl

@@ -0,0 +1,9 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+stack {
+  name        = "package cloudstore // import \"github.com/terramate-io/terramate/cloud/testserver/cloudstore\""
+  description = "package cloudstore // import \"github.com/terramate-io/terramate/cloud/testserver/cloudstore\""
+  tags        = ["cloud", "cloudstore", "golang", "testserver"]
+  id          = "264e8e28-bddc-4244-a2c9-9dfb4e9cfd33"
+}

cloud/testserver/stack.tm.hcl

@@ -0,0 +1,9 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+stack {
+  name        = "package testserver // import \"github.com/terramate-io/terramate/cloud/testserver\""
+  description = "package testserver // import \"github.com/terramate-io/terramate/cloud/testserver\""
+  tags        = ["cloud", "golang", "testserver"]
+  id          = "6f6e494b-d500-4024-95ef-b273f459b61c"
+}

cmd/terramate/cli/cliconfig/_test_mock.tf

@@ -0,0 +1,6 @@
+// TERRAMATE: GENERATED AUTOMATICALLY DO NOT EDIT
+
+resource "local_file" "foo" {
+  content  = "package cliconfig // import \"github.com/terramate-io/terramate/cmd/terramate/cli/cliconfig\""
+  filename = "${path.module}/mock.ignore"
+}

cmd/terramate/cli/cliconfig/stack.tm.hcl

@@ -0,0 +1,9 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+stack {
+  name        = "package cliconfig // import \"github.com/terramate-io/terramate/cmd/terramate/cli/cliconfig\""
+  description = "package cliconfig // import \"github.com/terramate-io/terramate/cmd/terramate/cli/cliconfig\""
+  tags        = ["cli", "cliconfig", "cmd", "golang", "terramate"]
+  id          = "d9636c0a-f69c-47c7-8657-9ff5cdc454f3"
+}

cmd/terramate/cli/github/_test_mock.tf

@@ -0,0 +1,6 @@
+// TERRAMATE: GENERATED AUTOMATICALLY DO NOT EDIT
+
+resource "local_file" "foo" {
+  content  = "package github // import \"github.com/terramate-io/terramate/cmd/terramate/cli/github\""
+  filename = "${path.module}/mock.ignore"
+}

cmd/terramate/cli/github/stack.tm.hcl

@@ -0,0 +1,9 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+stack {
+  name        = "package github // import \"github.com/terramate-io/terramate/cmd/terramate/cli/github\""
+  description = "package github // import \"github.com/terramate-io/terramate/cmd/terramate/cli/github\""
+  tags        = ["cli", "cmd", "github", "golang", "terramate"]
+  id          = "6347be57-01f6-47cf-871a-6a7afe89b553"
+}

cmd/terramate/cli/gitlab/_test_mock.tf

@@ -0,0 +1,6 @@
+// TERRAMATE: GENERATED AUTOMATICALLY DO NOT EDIT
+
+resource "local_file" "foo" {
+  content  = "package gitlab // import \"github.com/terramate-io/terramate/cmd/terramate/cli/gitlab\""
+  filename = "${path.module}/mock.ignore"
+}

cmd/terramate/cli/gitlab/stack.tm.hcl

@@ -0,0 +1,9 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+stack {
+  name        = "package gitlab // import \"github.com/terramate-io/terramate/cmd/terramate/cli/gitlab\""
+  description = "package gitlab // import \"github.com/terramate-io/terramate/cmd/terramate/cli/gitlab\""
+  tags        = ["cli", "cmd", "gitlab", "golang", "terramate"]
+  id          = "9be406d8-ca18-48fb-ac5d-6c84efe8ff9d"
+}

cmd/terramate/cli/out/_test_mock.tf

@@ -0,0 +1,6 @@
+// TERRAMATE: GENERATED AUTOMATICALLY DO NOT EDIT
+
+resource "local_file" "foo" {
+  content  = "package out // import \"github.com/terramate-io/terramate/cmd/terramate/cli/out\""
+  filename = "${path.module}/mock.ignore"
+}