mirror of
https://github.com/kreuzwerker/terraform-provider-docker.git
synced 2025-12-20 22:59:42 -05:00
6c796e15a5
* chore: add tfplugindocs tool
* feat: add tfplugin doc dependency and make target
* chore: apply documentation generation
* docs(contributing): update for documentation generation
* fix: adapt website-lint target to new do folder
* docs(network): update ds descriptions
* docs: add template for index.md
* docs: add network resource generation
* chore(ci): updates paths for website checks
* docs: add plugin data source generation
* docs: add import cmd for network resource
* docs: add plugin resource generation
* feat: outlines remaining resources with example and import cmd
* feat: add descriptions to docs
* chore: add DevSkim ignores and fix capitalized errors
* docs: complete ds registry image
* docs: add container resource generation
* docs: add lables description to missing resources
* docs: remove computed:true from network data
so the list is rendered in the description
* Revert "docs: remove computed:true from network data"
This reverts commit dce9b7a5a2.
* docs: add docker image descriptions to generate the docs
* docs: add docker registry image descriptions to generate the docs
* docs: add docker service descriptions to generate the docs
* docs: add docker volume descriptions to generate the docs
* docs(index): clarifies description
so more docker resources are mentioned
* docs(network): fixes required and read-only attributes
so the ds can only be read by-name
* docs(plugin): clarifies the ds docs attributes
* docs: fix typo registry image ds
* docs(config): clarifies attributes and enhances examples
Provide a long example and import command
* fix(config): make data non-sensitive
Because only secrets data is
* docs(containter): clarifies attributes
and enhances examples with import
* docs(config): fix typo
* docs(image): clarifies attributes and remove import
* docs(network): clarifies attributes and adapts import
* docs(plugin): clarifies attributes and import
* docs(registry_image): clarifies attributes and removes import
* chore(secret): remove typo
* docs(service): clarifies attributes and import
* docs(volume): clarifies attributes and import
* fix: correct md linter rules after doc gen
* docs(volume): regenerated
* docs: add config custom template
* docs: add templates for all resources
* docs(config): templates all sections and examples
for better redability and structure
* docs(config): fix md linter
* docs(container): templates all sections and examples
* docs(image): templates all sections and examples
* docs(image): fix import resource by renaming
* docs(network): templates all sections and examples
* docs(service): templates all sections and examples
* docs(volume): templates all sections and examples
* fix(lint): replace website with doc directory
* fix(ci): link check file extension check
* fix: markdown links
* chore: remove old website folder
* chore: fix website-lint terrafmr dir and pattern
* fix: lint fix target website folder
* fix: website links
* docs(provider): update examples
with templates on auth and certs
* docs(provider): add tf-plugin-docs line
* docs(contributing): split doc generation section
* docs: final brush up for readability and structure
* chore(ci): add website-generation job
to see if files changed and it should run locally again
* chore(ci): remove explicit docker setup
from website lint because it's installed by default
96 lines
3.1 KiB
Makefile
96 lines
3.1 KiB
Makefile
TEST?=$$(go list ./... |grep -v 'vendor')
|
|
GOFMT_FILES?=$$(find . -name '*.go' |grep -v vendor)
|
|
PKG_NAME=internal/provider
|
|
|
|
default: build
|
|
|
|
build: fmtcheck
|
|
go install
|
|
|
|
setup:
|
|
go mod download
|
|
cd tools && GO111MODULE=on go install github.com/client9/misspell/cmd/misspell
|
|
cd tools && GO111MODULE=on go install github.com/katbyte/terrafmt
|
|
cd tools && GO111MODULE=on go install github.com/golangci/golangci-lint/cmd/golangci-lint
|
|
cd tools && GO111MODULE=on go install github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs
|
|
rm -f .git/hooks/commit-msg \
|
|
&& curl --fail -o .git/hooks/commit-msg https://raw.githubusercontent.com/hazcod/semantic-commit-hook/master/commit-msg \
|
|
&& chmod 500 .git/hooks/commit-msg
|
|
|
|
golangci-lint:
|
|
@golangci-lint run ./$(PKG_NAME)/...
|
|
|
|
test: fmtcheck
|
|
go test -i $(TEST) || exit 1
|
|
echo $(TEST) | \
|
|
xargs -t -n4 go test $(TESTARGS) -timeout=30s -parallel=4
|
|
|
|
testacc_setup: fmtcheck
|
|
@sh -c "'$(CURDIR)/scripts/testacc_setup.sh'"
|
|
|
|
testacc: fmtcheck
|
|
@sh -c "'$(CURDIR)/scripts/testacc_full.sh'"
|
|
|
|
testacc_cleanup: fmtcheck
|
|
@sh -c "'$(CURDIR)/scripts/testacc_cleanup.sh'"
|
|
|
|
compile: fmtcheck
|
|
@sh -c "curl -sL https://git.io/goreleaser | bash -s -- --rm-dist --skip-publish --snapshot --skip-sign"
|
|
|
|
vet:
|
|
@echo "go vet ."
|
|
@go vet $$(go list ./... | grep -v vendor/) ; if [ $$? -eq 1 ]; then \
|
|
echo ""; \
|
|
echo "Vet found suspicious constructs. Please check the reported constructs"; \
|
|
echo "and fix them if necessary before submitting the code for review."; \
|
|
exit 1; \
|
|
fi
|
|
|
|
fmt:
|
|
gofmt -s -w $(GOFMT_FILES)
|
|
|
|
fmtcheck:
|
|
@sh -c "'$(CURDIR)/scripts/gofmtcheck.sh'"
|
|
|
|
errcheck:
|
|
@sh -c "'$(CURDIR)/scripts/errcheck.sh'"
|
|
|
|
|
|
test-compile:
|
|
@if [ "$(TEST)" = "./..." ]; then \
|
|
echo "ERROR: Set TEST to a specific package. For example,"; \
|
|
echo " make test-compile TEST=./$(PKG_NAME)"; \
|
|
exit 1; \
|
|
fi
|
|
go test -c $(TEST) $(TESTARGS)
|
|
|
|
website-generation:
|
|
go generate
|
|
|
|
website-link-check:
|
|
@scripts/markdown-link-check.sh
|
|
|
|
website-lint:
|
|
@echo "==> Checking website against linters..."
|
|
@misspell -error -source=text docs/ || (echo; \
|
|
echo "Unexpected mispelling found in website files."; \
|
|
echo "To automatically fix the misspelling, run 'make website-lint-fix' and commit the changes."; \
|
|
exit 1)
|
|
@docker run -v $(PWD):/markdown 06kellyjac/markdownlint-cli docs/ || (echo; \
|
|
echo "Unexpected issues found in website Markdown files."; \
|
|
echo "To apply any automatic fixes, run 'make website-lint-fix' and commit the changes."; \
|
|
exit 1)
|
|
@terrafmt diff ./docs --check --pattern '*.md' --quiet || (echo; \
|
|
echo "Unexpected differences in website HCL formatting."; \
|
|
echo "To see the full differences, run: terrafmt diff ./docs --pattern '*.md'"; \
|
|
echo "To automatically fix the formatting, run 'make website-lint-fix' and commit the changes."; \
|
|
exit 1)
|
|
|
|
website-lint-fix:
|
|
@echo "==> Applying automatic website linter fixes..."
|
|
@misspell -w -source=text docs/
|
|
@docker run -v $(PWD):/markdown 06kellyjac/markdownlint-cli --fix docs/
|
|
@terrafmt fmt ./docs --pattern '*.md'
|
|
|
|
.PHONY: build test testacc vet fmt fmtcheck errcheck test-compile website-link-check website-lint website-lint-fix
|
|
|