ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
terraform/Makefile

74 lines
2.7 KiB
Makefile
Raw Normal View History

make: Add website + website-test targets
2018-05-02 13:43:14 +02:00
WEBSITE_REPO=github.com/hashicorp/terraform-website
Fix missing VERSION for running make website
2020-08-12 19:24:03 +02:00
VERSION?="0.3.44"
Initial work on config
2014-05-23 01:56:28 +02:00
Comment Makefile
2015-01-27 03:19:22 +01:00
# generate runs `go generate` to build the dynamically generated
build: Take protoc out of the "go generate" path Since protoc is not go-gettable, and most development tasks in Terraform won't involve recompiling protoc files anyway, we'll use a separate mechanism for these. This way "go generate" only depends on things we can "go get" in the "make tools" target. In a later commit we should also in some way specify a particular version of protoc to use so that we don't get "flapping" regenerations as developers work with different versions, but the priority here is just to make "make generate" minimally usable again to restore the dev workflow documented in the README. This also includes some updates that resulted from running "make generate" and "make protobuf" after those Makefile changes were in place.
2018-10-18 18:27:48 +02:00
# source files, except the protobuf stubs which are built instead with
# "make protobuf".
Version tools per Go convention under tools.go
2019-10-17 22:17:23 +02:00
generate:
remove vendor from some tooling
2020-09-23 22:57:36 +02:00
go generate ./...
helper/schema: generate strings for ValueType
2015-01-11 00:51:53 +01:00
build: Take protoc out of the "go generate" path Since protoc is not go-gettable, and most development tasks in Terraform won't involve recompiling protoc files anyway, we'll use a separate mechanism for these. This way "go generate" only depends on things we can "go get" in the "make tools" target. In a later commit we should also in some way specify a particular version of protoc to use so that we don't get "flapping" regenerations as developers work with different versions, but the priority here is just to make "make generate" minimally usable again to restore the dev workflow documented in the README. This also includes some updates that resulted from running "make generate" and "make protobuf" after those Makefile changes were in place.
2018-10-18 18:27:48 +02:00
# 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 you may either use
# this target or run the individual scripts below directly.
protobuf:
make: Add check for protobuf dependencies
2019-09-05 14:30:48 +02:00
bash scripts/protobuf-check.sh
plugin: Establish our current plugin protocol as version 5 The main significant change here is that the package name for the proto definition is "tfplugin5", which is important because this name is part of the wire protocol for references to types defined in our package. Along with that, we also move the generated package into "internal" to make it explicit that importing the generated Go package from elsewhere is not the right approach for externally-implemented SDKs, which should instead vendor the proto definition they are using and generate their own stubs to ensure that the wire protocol is the only hard dependency between Terraform Core and plugins. After this is merged, any provider binaries built against our helper/schema package will need to be rebuilt so that they use the new "tfplugin5" package name instead of "proto". In a future commit we will include more elaborate and organized documentation on how an external codebase might make use of our RPC interface definition to implement an SDK, but the primary concern here is to ensure we have the right wire package name before release.
2018-11-19 18:39:16 +01:00
bash internal/tfplugin5/generate.sh
build: Take protoc out of the "go generate" path Since protoc is not go-gettable, and most development tasks in Terraform won't involve recompiling protoc files anyway, we'll use a separate mechanism for these. This way "go generate" only depends on things we can "go get" in the "make tools" target. In a later commit we should also in some way specify a particular version of protoc to use so that we don't get "flapping" regenerations as developers work with different versions, but the priority here is just to make "make generate" minimally usable again to restore the dev workflow documented in the README. This also includes some updates that resulted from running "make generate" and "make protobuf" after those Makefile changes were in place.
2018-10-18 18:27:48 +02:00
bash plans/internal/planproto/generate.sh
Make gofmt errors fail build and add `make fmt` We may want to consider requiring `gofmt -s` compliance in future builds, but for now we just use `gofmt`.
2015-12-17 18:21:43 +01:00
fmtcheck:
@sh -c "'$(CURDIR)/scripts/gofmtcheck.sh'"
make: Add website + website-test targets
2018-05-02 13:43:14 +02:00
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}
website-test:
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 "==> Testing core website in Docker..."
-@docker stop "tf-website-core-temp"
@docker run \
--detach \
--rm \
--name "tf-website-core-temp" \
--publish "4567:4567" \
--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}
$(WEBSITE_PATH)/content/scripts/check-links.sh "http://127.0.0.1:4567" "/" "/docs/providers/*"
@docker stop "tf-website-core-temp"
Disallow parallelism in Makefile
2017-02-18 00:31:20 +01:00
# 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:
Makefile: remove unused targets Most of the targets in the Makefile have not been used in either CI or the normal development workflow for some time. Removing them clarifies that the expected way to build Terraform locally is simple: go install. Remaining targets: - fmtcheck, generate: these are used in CI to verify that the code is correctly formatted and that generate has been run appropriately - protobuf: referenced in CONTRIBUTING.md as the simplest way to build the proto files - website, website-test: used to compile and test the local website in isolation from the terraform-website repo
2020-06-05 14:47:15 +02:00
.PHONY: fmtcheck generate protobuf website website-test