1+ # This workflow builds the product for all supported platforms and uploads the resulting
2+ # binaries as Actions artifacts. The workflow also uploads a build metadata file
3+ # (metadata.json) -- and a Terraform Registry manifest file (terraform-registry-manifest.json).
4+ #
5+ # Reference: https://github.com/hashicorp/terraform-provider-crt-example/blob/main/.github/workflows/README.md
6+ #
7+
8+ name : build
9+
10+ # We default to running this workflow on every push to every branch.
11+ # This provides fast feedback when build issues occur, so they can be
12+ # fixed prior to being merged to the main branch.
13+ #
14+ # If you want to opt out of this, and only run the build on certain branches
15+ # please refer to the documentation on branch filtering here:
16+ #
17+ # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#onpushbranchestagsbranches-ignoretags-ignore
18+ #
19+ on : [workflow_dispatch, push]
20+
21+ env :
22+ PKG_NAME : " terraform-provider-archive"
23+
24+ jobs :
25+ # Detects the Go toolchain version to use for product builds.
26+ #
27+ # The implementation is inspired by envconsul -- https://go.hashi.co/get-go-version-example
28+ get-go-version :
29+ name : " Detect Go toolchain version"
30+ runs-on : ubuntu-latest
31+ outputs :
32+ go-version : ${{ steps.get-go-version.outputs.go-version }}
33+ steps :
34+ - uses : actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
35+ - uses : actions/setup-go@d35c59abb061a4a6fb18e82ac0862c26744d6ab5 # v5.5.0
36+ with :
37+ go-version-file : ' go.mod'
38+ - name : Detect Go version
39+ id : get-go-version
40+ run : |
41+ version="$(go list -f {{.GoVersion}} -m)"
42+ echo "go-version=$version" >> "$GITHUB_OUTPUT"
43+
44+ # Parses the version/VERSION file. Reference: https://github.com/hashicorp/actions-set-product-version/blob/main/README.md
45+ #
46+ # > This action should be implemented in product repo `build.yml` files. The action is intended to grab the version
47+ # > from the version file at the beginning of the build, then passes those versions (along with metadata, where
48+ # > necessary) to any workflow jobs that need version information.
49+ set-product-version :
50+ name : " Parse version file"
51+ runs-on : ubuntu-latest
52+ outputs :
53+ product-version : ${{ steps.set-product-version.outputs.product-version }}
54+ product-base-version : ${{ steps.set-product-version.outputs.base-product-version }}
55+ product-prerelease-version : ${{ steps.set-product-version.outputs.prerelease-product-version }}
56+ product-minor-version : ${{ steps.set-product-version.outputs.minor-product-version }}
57+ steps :
58+ - uses : actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
59+ - name : Set variables
60+ id : set-product-version
61+ uses : hashicorp/actions-set-product-version@v2
62+
63+ # Creates metadata.json file containing build metadata for consumption by CRT workflows.
64+ #
65+ # Reference: https://github.com/hashicorp/actions-generate-metadata/blob/main/README.md
66+ generate-metadata-file :
67+ needs : set-product-version
68+ runs-on : ubuntu-latest
69+ outputs :
70+ filepath : ${{ steps.generate-metadata-file.outputs.filepath }}
71+ steps :
72+ - name : " Checkout directory"
73+ uses : actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
74+ - name : Generate metadata file
75+ id : generate-metadata-file
76+ uses : hashicorp/actions-generate-metadata@v1
77+ with :
78+ version : ${{ needs.set-product-version.outputs.product-version }}
79+ product : ${{ env.PKG_NAME }}
80+ repositoryOwner : " hashicorp"
81+ - uses : actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
82+ with :
83+ name : metadata.json
84+ path : ${{ steps.generate-metadata-file.outputs.filepath }}
85+
86+ # Uploads an Actions artifact named terraform-registry-manifest.json.zip.
87+ #
88+ # The artifact contains a single file with a filename that Terraform Registry expects
89+ # (example: terraform-provider-crt-example_2.3.6-alpha1_manifest.json). The file contents
90+ # are identical to the terraform-registry-manifest.json file in the source repository.
91+ upload-terraform-registry-manifest-artifact :
92+ needs : set-product-version
93+ runs-on : ubuntu-latest
94+ steps :
95+ - name : " Checkout directory"
96+ uses : actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
97+ with :
98+ path : ${{ env.PKG_NAME }}
99+ - name : " Copy manifest from checkout directory to a file with the desired name"
100+ id : terraform-registry-manifest
101+ run : |
102+ name="${{ env.PKG_NAME }}"
103+ version="${{ needs.set-product-version.outputs.product-version }}"
104+
105+ source="${name}/terraform-registry-manifest.json"
106+ destination="${name}_${version}_manifest.json"
107+
108+ cp "$source" "$destination"
109+ echo "filename=$destination" >> "$GITHUB_OUTPUT"
110+ - uses : actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
111+ with :
112+ name : terraform-registry-manifest.json
113+ path : ${{ steps.terraform-registry-manifest.outputs.filename }}
114+ if-no-files-found : error
115+
116+ # Builds the product for all platforms except macOS.
117+ #
118+ # With `reproducible: report`, this job also reports whether the build is reproducible,
119+ # but does not enforce it.
120+ #
121+ # Reference: https://github.com/hashicorp/actions-go-build/blob/main/README.md
122+ build :
123+ needs :
124+ - get-go-version
125+ - set-product-version
126+ runs-on : ubuntu-latest
127+ strategy :
128+ fail-fast : true
129+ # Verify expected Artifacts list for a workflow run.
130+ matrix :
131+ goos : [freebsd, windows, linux, darwin]
132+ goarch : ["386", "amd64", "arm", "arm64"]
133+ exclude :
134+ - goos : freebsd
135+ goarch : arm64
136+ - goos : windows
137+ goarch : arm64
138+ - goos : windows
139+ goarch : arm
140+ - goos : darwin
141+ goarch : 386
142+ - goos : darwin
143+ goarch : arm
144+
145+ name : Go ${{ needs.get-go-version.outputs.go-version }} ${{ matrix.goos }} ${{ matrix.goarch }} build
146+ steps :
147+ - uses : actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
148+ - uses : hashicorp/actions-go-build@v1
149+ env :
150+ CGO_ENABLED : 0
151+ BASE_VERSION : ${{ needs.set-product-version.outputs.product-base-version }}
152+ PRERELEASE_VERSION : ${{ needs.set-product-version.outputs.product-prerelease-version}}
153+ METADATA_VERSION : ${{ env.METADATA }}
154+ with :
155+ bin_name : " ${{ env.PKG_NAME }}_v${{ needs.set-product-version.outputs.product-version }}_x5"
156+ product_name : ${{ env.PKG_NAME }}
157+ product_version : ${{ needs.set-product-version.outputs.product-version }}
158+ go_version : ${{ needs.get-go-version.outputs.go-version }}
159+ os : ${{ matrix.goos }}
160+ arch : ${{ matrix.goarch }}
161+ reproducible : report
162+ instructions : |
163+ go build \
164+ -o "$BIN_PATH" \
165+ -trimpath \
166+ -buildvcs=false \
167+ -ldflags "-s -w"
168+ cp LICENSE "$TARGET_DIR/LICENSE.txt"
169+
170+ whats-next :
171+ needs :
172+ - build
173+ - generate-metadata-file
174+ - upload-terraform-registry-manifest-artifact
175+ runs-on : ubuntu-latest
176+ name : " What's next?"
177+ steps :
178+ - name : " Write a helpful summary"
179+ run : |
180+ github_dot_com="${{ github.server_url }}"
181+ owner_with_name="${{ github.repository }}"
182+ ref="${{ github.ref }}"
183+
184+ echo "### What's next?" >> "$GITHUB_STEP_SUMMARY"
185+ echo "#### For a release branch (see \`.release/ci.hcl\`)" >> $GITHUB_STEP_SUMMARY
186+ echo "After this \`build\` workflow run completes succesfully, you can expect the CRT \`prepare\` workflow to begin momentarily." >> "$GITHUB_STEP_SUMMARY"
187+ echo "To find the \`prepare\` workflow run, [view the checks for this commit]($github_dot_com/$owner_with_name/commits/$ref)" >> "$GITHUB_STEP_SUMMARY"
0 commit comments