mirror of
https://github.com/opentofu/opentofu.git
synced 2025-01-02 12:17:39 -06:00
ce96d82de0
We have a few different .proto files in this repository that all need to get recompiled into .pb.go files each time we change them, but we were previously handling that with some scripts that just assumed that protoc and the relevant plugins were already installed on the system somewhere, at the right versions. In practice we've been constantly flopping between different versions of these tools due to folks having different versions installed in their development environments. In particular, the state of the .pb.go files in the prior commit wasn't reproducible by any single version of the tools because they've all slightly diverged from one another. In the interests of being more consistent here and avoiding accidental inconsistencies, we'll now centralize the protocol buffer compile steps all into a single tool that knows how to fetch and install the expected versions of the various tools we need and then run those tools with the right options to get a stable result. If we want to upgrade to either a newer protoc or a newer protoc-gen-go in future then we'll do that in a central location and update all of the .pb.go files at the same time, so that we're always consistently tracking the same version of protocol buffers everywhere. While doing this I attempted to keep as close as possible to the toolchain we'd most recently used, but since they were not consistent with each other they've now all changed which version numbers they record at minimum, and the planproto stub in particular now also has a slightly different descriptor serialization but is otherwise offering the same API.
50 lines
1.8 KiB
Makefile
50 lines
1.8 KiB
Makefile
WEBSITE_REPO=github.com/hashicorp/terraform-website
|
|
VERSION?="0.3.44"
|
|
|
|
# generate runs `go generate` to build the dynamically generated
|
|
# source files, except the protobuf stubs which are built instead with
|
|
# "make protobuf".
|
|
generate:
|
|
go generate ./...
|
|
|
|
# We separate the protobuf generation because most development tasks on
|
|
# Terraform do not involve changing protobuf files and protoc is not a
|
|
# go-gettable dependency and so getting it installed can be inconvenient.
|
|
#
|
|
# If you are working on changes to protobuf interfaces, run this Makefile
|
|
# target to be sure to regenerate all of the protobuf stubs using the expected
|
|
# versions of protoc and the protoc Go plugins.
|
|
protobuf:
|
|
go run ./tools/protobuf-compile .
|
|
|
|
fmtcheck:
|
|
@sh -c "'$(CURDIR)/scripts/gofmtcheck.sh'"
|
|
|
|
website:
|
|
ifeq (,$(wildcard $(GOPATH)/src/$(WEBSITE_REPO)))
|
|
echo "$(WEBSITE_REPO) not found in your GOPATH (necessary for layouts and assets), get-ting..."
|
|
git clone https://$(WEBSITE_REPO) $(GOPATH)/src/$(WEBSITE_REPO)
|
|
endif
|
|
$(eval WEBSITE_PATH := $(GOPATH)/src/$(WEBSITE_REPO))
|
|
@echo "==> Starting core website in Docker..."
|
|
@docker run \
|
|
--interactive \
|
|
--rm \
|
|
--tty \
|
|
--publish "4567:4567" \
|
|
--publish "35729:35729" \
|
|
--volume "$(shell pwd)/website:/website" \
|
|
--volume "$(shell pwd):/ext/terraform" \
|
|
--volume "$(WEBSITE_PATH)/content:/terraform-website" \
|
|
--volume "$(WEBSITE_PATH)/content/source/assets:/website/docs/assets" \
|
|
--volume "$(WEBSITE_PATH)/content/source/layouts:/website/docs/layouts" \
|
|
--workdir /terraform-website \
|
|
hashicorp/middleman-hashicorp:${VERSION}
|
|
|
|
# disallow any parallelism (-j) for Make. This is necessary since some
|
|
# commands during the build process create temporary files that collide
|
|
# under parallel conditions.
|
|
.NOTPARALLEL:
|
|
|
|
.PHONY: fmtcheck generate protobuf website website-test
|