IntenseWebs/opentofu
3
0
Fork 0
mirror of https://github.com/opentofu/opentofu.git synced 2024-12-26 17:01:04 -06:00
Code Issues Packages Projects Releases Wiki Activity
16c6432c3a
opentofu/Makefile

65 lines
1.7 KiB
Makefile
Raw Normal View History

feat: add license checks on dependencies (#310) Co-authored-by: Roni Frantchi <roni-frantchi@users.noreply.github.com>
2023-09-13 11:10:41 -05:00
export PATH := $(abspath bin/):${PATH}
# Dependency versions
LICENSEI_VERSION = 0.9.0
Comment Makefile
2015-01-26 20:19:22 -06: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 11:27:48 -05:00
# source files, except the protobuf stubs which are built instead with
# "make protobuf".
feat: add license checks on dependencies (#310) Co-authored-by: Roni Frantchi <roni-frantchi@users.noreply.github.com>
2023-09-13 11:10:41 -05:00
.PHONY: generate
Version tools per Go convention under tools.go
2019-10-17 15:17:23 -05:00
generate:
remove vendor from some tooling
2020-09-23 15:57:36 -05:00
go generate ./...
helper/schema: generate strings for ValueType
2015-01-10 17:51:53 -06: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 11:27:48 -05:00
# We separate the protobuf generation because most development tasks on
Rename to opentofu docs and root folder (#529)
2023-09-21 04:53:02 -05:00
# OpenTofu do not involve changing protobuf files and protoc is not a
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 11:27:48 -05:00
# go-gettable dependency and so getting it installed can be inconvenient.
#
build: Centralize our protobuf compilation steps 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.
2021-08-20 18:07:18 -05:00
# 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.
feat: add license checks on dependencies (#310) Co-authored-by: Roni Frantchi <roni-frantchi@users.noreply.github.com>
2023-09-13 11:10:41 -05:00
.PHONY: protobuf
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 11:27:48 -05:00
protobuf:
build: Centralize our protobuf compilation steps 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.
2021-08-20 18:07:18 -05:00
go run ./tools/protobuf-compile .
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 11:27:48 -05:00
feat: add license checks on dependencies (#310) Co-authored-by: Roni Frantchi <roni-frantchi@users.noreply.github.com>
2023-09-13 11:10:41 -05:00
.PHONY: fmtcheck
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 11:21:43 -06:00
fmtcheck:
build: Run scripts directly from makefile, rather than via sh All four of these scripts have #! lines calling for them to run in bash, and they are all marked as executable, so there's no harm in running them directly and it makes it clearer that we're running them in the shell specified on the #! line, rather than with whatever "sh' happens to be on the current system. (Note that this _was_ still correctly using the #! lines before, because it's `sh -c` rather than just `sh`, but nonetheless that old way seemed needlessly confusing.)
2022-08-25 17:49:39 -05:00
"$(CURDIR)/scripts/gofmtcheck.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 11:21:43 -06:00
feat: add license checks on dependencies (#310) Co-authored-by: Roni Frantchi <roni-frantchi@users.noreply.github.com>
2023-09-13 11:10:41 -05:00
.PHONY: importscheck
Add goimports as a check to the Github commit actions (#31432) * Add goimports as a check to the Github commit actions * check diff against main instead of last commit * goimports should fix the problems * fix up conditionals and wildcard matching * specify origin/main in diff * fetch main branch when checkout * back to origin main
2022-07-19 04:14:28 -05:00
importscheck:
build: Run scripts directly from makefile, rather than via sh All four of these scripts have #! lines calling for them to run in bash, and they are all marked as executable, so there's no harm in running them directly and it makes it clearer that we're running them in the shell specified on the #! line, rather than with whatever "sh' happens to be on the current system. (Note that this _was_ still correctly using the #! lines before, because it's `sh -c` rather than just `sh`, but nonetheless that old way seemed needlessly confusing.)
2022-08-25 17:49:39 -05:00
"$(CURDIR)/scripts/goimportscheck.sh"
Add goimports as a check to the Github commit actions (#31432) * Add goimports as a check to the Github commit actions * check diff against main instead of last commit * goimports should fix the problems * fix up conditionals and wildcard matching * specify origin/main in diff * fetch main branch when checkout * back to origin main
2022-07-19 04:14:28 -05:00
feat: add license checks on dependencies (#310) Co-authored-by: Roni Frantchi <roni-frantchi@users.noreply.github.com>
2023-09-13 11:10:41 -05:00
.PHONY: staticcheck
add staticcheck make target cleanup the old fmtcheck script while we're in here
2020-12-02 11:02:33 -06:00
staticcheck:
build: Run scripts directly from makefile, rather than via sh All four of these scripts have #! lines calling for them to run in bash, and they are all marked as executable, so there's no harm in running them directly and it makes it clearer that we're running them in the shell specified on the #! line, rather than with whatever "sh' happens to be on the current system. (Note that this _was_ still correctly using the #! lines before, because it's `sh -c` rather than just `sh`, but nonetheless that old way seemed needlessly confusing.)
2022-08-25 17:49:39 -05:00
"$(CURDIR)/scripts/staticcheck.sh"
add staticcheck make target cleanup the old fmtcheck script while we're in here
2020-12-02 11:02:33 -06:00
feat: add license checks on dependencies (#310) Co-authored-by: Roni Frantchi <roni-frantchi@users.noreply.github.com>
2023-09-13 11:10:41 -05:00
.PHONY: exhaustive
build: Add exhaustive switch statement lint For now, only check the JSON views package, since this was the instance that most recently tripped us up. There are a few dozen failures elsewhere in Terraform which would need to be addressed before expanding this to other packages.
2021-09-24 14:02:30 -05:00
exhaustive:
build: Run scripts directly from makefile, rather than via sh All four of these scripts have #! lines calling for them to run in bash, and they are all marked as executable, so there's no harm in running them directly and it makes it clearer that we're running them in the shell specified on the #! line, rather than with whatever "sh' happens to be on the current system. (Note that this _was_ still correctly using the #! lines before, because it's `sh -c` rather than just `sh`, but nonetheless that old way seemed needlessly confusing.)
2022-08-25 17:49:39 -05:00
"$(CURDIR)/scripts/exhaustive.sh"
build: Add exhaustive switch statement lint For now, only check the JSON views package, since this was the instance that most recently tripped us up. There are a few dozen failures elsewhere in Terraform which would need to be addressed before expanding this to other packages.
2021-09-24 14:02:30 -05:00
feat: add license checks on dependencies (#310) Co-authored-by: Roni Frantchi <roni-frantchi@users.noreply.github.com>
2023-09-13 11:10:41 -05:00
# Run license check
.PHONY: license-check
license-check:
go mod vendor
fix(ci): allow disabling licensei checks by env var and cache dependencies license information to avoid GitHub API rate limiting (#412)
2023-09-18 07:25:42 -05:00
licensei cache --debug
licensei check --debug
licensei header --debug
rm -rf vendor/
git diff --exit-code
feat: add license checks on dependencies (#310) Co-authored-by: Roni Frantchi <roni-frantchi@users.noreply.github.com>
2023-09-13 11:10:41 -05:00
# Install dependencies
deps: bin/licensei
deps:
bin/licensei: bin/licensei-${LICENSEI_VERSION}
@ln -sf licensei-${LICENSEI_VERSION} bin/licensei
bin/licensei-${LICENSEI_VERSION}:
@mkdir -p bin
curl -sfL https://git.io/licensei | bash -s v${LICENSEI_VERSION}
@mv bin/licensei $@
Disallow parallelism in Makefile
2017-02-17 17:31:20 -06: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:
Reference in New Issue Copy Permalink