Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
DockerCLI/Makefile

80 lines
2.1 KiB
Makefile
Raw Normal View History

add Makefiles and document their use in the README Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2017-04-25 12:57:06 -04:00
#
Display proper version information - The cli version defaults to "unknown-version" unless set via the VERSION env var - The commit version can be overridden via GITCOMMIT env var - The build time can be overridden via BUILDTIME env var Signed-off-by: Kenfe-Mickael Laventure <mickael.laventure@gmail.com>
2017-05-09 12:38:23 -04:00
# github.com/docker/cli
add Makefiles and document their use in the README Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2017-04-25 12:57:06 -04:00
#
Use goversioninfo to create Windows Version Info Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-10-11 10:54:09 -04:00
# Sets the name of the company that produced the windows binary.
Change "COMPANY_NAME" to "PACKAGER_NAME" The COMPANY_NAME currently sets the "CompanyName" field in the metadata of Windows binaries. Our intent of this field is this field to contain information about the company/party that produced the binary. Also from [FileVersionInfo.CompanyName][FileVersionInfo.CompanyName]: > Gets the name of the company that produced the file Based on the above, "PACKAGER_NAME" is a bit more generic, and clearer on intent, and we may at some point re-use this same information to propagate equivalent fields on other platforms (rpms, debs) [FileVersionInfo.CompanyName]: https://docs.microsoft.com/en-us/dotnet/api/system.diagnostics.fileversioninfo.companyname Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-03-27 04:09:50 -04:00
PACKAGER_NAME ?=
Use goversioninfo to create Windows Version Info Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-10-11 10:54:09 -04:00
Update the README Remove referenced to developing on the host, we shouldn't support it. Move script/validate to scripts/validate to be consistent. Set the default target to be binary instead of clean. Signed-off-by: Daniel Nephin <dnephin@docker.com>
2017-05-14 13:24:10 -04:00
all: binary
Add a warning when make is run outside of a container. The warning can be disabled by setting the environment variable Signed-off-by: Daniel Nephin <dnephin@docker.com>
2017-06-23 00:52:34 -04:00
_:=$(shell ./scripts/warn-outside-container $(MAKECMDGOALS))
update makefiles: add “vendor” target in docker.Makefile… … so that contributors don’t need “vndr” on their laptop Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2017-05-09 17:29:14 -04:00
.PHONY: clean
Update README and add help target to make Signed-off-by: Jean-Pierre Huynh <jean-pierre.huynh@ounet.fr>
2017-07-19 11:44:39 -04:00
clean: ## remove build artifacts
validate manpages target Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-02-25 11:05:35 -05:00
rm -rf ./build/* man/man[1-9] docs/yaml
add Makefiles and document their use in the README Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2017-04-25 12:57:06 -04:00
Re-adds test target to the Makefile The test target existed before, this is to provide a legacy interface to allow easy testing for downstream Docker CE. Without this we would need separate Makefiles/Jenkinsfiles for releases past 17.07. Later on this target could also be used to test both unit tests and integration tests at the same time. Signed-off-by: Eli Uriegas <eli.uriegas@docker.com>
2017-08-30 18:06:22 -04:00
.PHONY: test
test: test-unit ## run tests
ci: github actions test workflow Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-12-07 08:50:16 -05:00
.PHONY: test-unit
test-unit: ## run unit tests, to change the output format use: GOTESTSUM_FORMAT=(dots|short|standard-quiet|short-verbose|standard-verbose) make test-unit
gotestsum -- $${TESTDIRS:-$(shell go list ./... | grep -vE '/vendor/|/e2e/')} $(TESTFLAGS)
Add test-coverage & codecov target and update circleci Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2017-05-18 04:48:24 -04:00
.PHONY: test-coverage
Update README and add help target to make Signed-off-by: Jean-Pierre Huynh <jean-pierre.huynh@ounet.fr>
2017-07-19 11:44:39 -04:00
test-coverage: ## run test coverage
ci: github actions test workflow Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-12-07 08:50:16 -05:00
mkdir -p $(CURDIR)/build/coverage
gotestsum -- $(shell go list ./... | grep -vE '/vendor/|/e2e/') -coverprofile=$(CURDIR)/build/coverage/coverage.txt
Add test-coverage & codecov target and update circleci Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2017-05-18 04:48:24 -04:00
GitHub Actions cross Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-09-26 12:01:38 -04:00
.PHONY: lint
lint: ## run all the lint tools
golangci-lint run
.PHONY: shellcheck
shellcheck: ## run shellcheck validation
find scripts/ contrib/completion/bash -type f | grep -v scripts/winresources | grep -v '.*.ps1' | xargs shellcheck
build: Add a `fmt` target which runs `gofmt` on all files. Signed-off-by: Ian Campbell <ijc@docker.com>
2018-12-10 08:17:14 -05:00
.PHONY: fmt
Makefile: add missing help messages for some targets Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-04-06 12:34:51 -04:00
fmt: ## run gofmt
build: Add a `fmt` target which runs `gofmt` on all files. Signed-off-by: Ian Campbell <ijc@docker.com>
2018-12-10 08:17:14 -05:00
go list -f {{.Dir}} ./... | xargs gofmt -w -s -d
Support building a dynbinary Cleanup dynbinary and binary builds Signed-off-by: Daniel Nephin <dnephin@docker.com>
2017-05-11 18:52:17 -04:00
.PHONY: binary
GitHub Actions cross Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-09-26 12:01:38 -04:00
binary: ## build executable for Linux
./scripts/build/binary
.PHONY: dynbinary
dynbinary: ## build dynamically linked binary
GO_LINKMODE=dynamic ./scripts/build/binary
Support building a dynbinary Cleanup dynbinary and binary builds Signed-off-by: Daniel Nephin <dnephin@docker.com>
2017-05-11 18:52:17 -04:00
Add basic framework for writing a CLI plugin That is, the helper to be used from the plugin's `main`. Also add a `helloworld` plugin example and build integration. Signed-off-by: Ian Campbell <ijc@docker.com>
2018-12-10 10:30:19 -05:00
.PHONY: plugins
plugins: ## build example CLI plugins
./scripts/build/plugins
vendor with go mod Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-12-16 15:15:53 -05:00
.PHONY: vendor
vendor: ## update vendor with go modules
Fix vendor validation vendor/ must be removed first, otherwise files added to vendor/ but not vendor.conf will not cause the validation to fail Signed-off-by: Daniel Nephin <dnephin@gmail.com>
2018-02-02 13:56:00 -05:00
rm -rf vendor
vendor with go mod Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-12-16 15:15:53 -05:00
./scripts/vendor update
.PHONY: validate-vendor
validate-vendor: ## validate vendor
./scripts/vendor validate
.PHONY: mod-outdated
mod-outdated: ## check outdated dependencies
./scripts/vendor outdated
Add check for compose bindata. Signed-off-by: Daniel Nephin <dnephin@docker.com>
2017-05-09 15:37:22 -04:00
Add AUTHORS file and script Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2018-01-02 09:47:31 -05:00
.PHONY: authors
authors: ## generate AUTHORS file from git history
scripts/docs/generate-authors.sh
Add scripts and targets for manpages and yamldocs Signed-off-by: Tibor Vass <tibor@docker.com>
2017-05-10 21:24:32 -04:00
.PHONY: manpages
Update README and add help target to make Signed-off-by: Jean-Pierre Huynh <jean-pierre.huynh@ounet.fr>
2017-07-19 11:44:39 -04:00
manpages: ## generate man pages from go source and markdown
fix manpages script Signed-off-by: Tibor Vass <tibor@docker.com>
2017-06-06 00:59:50 -04:00
scripts/docs/generate-man.sh
Add scripts and targets for manpages and yamldocs Signed-off-by: Tibor Vass <tibor@docker.com>
2017-05-10 21:24:32 -04:00
.PHONY: yamldocs
Update README and add help target to make Signed-off-by: Jean-Pierre Huynh <jean-pierre.huynh@ounet.fr>
2017-07-19 11:44:39 -04:00
yamldocs: ## generate documentation YAML files consumed by docs repo
Add scripts and targets for manpages and yamldocs Signed-off-by: Tibor Vass <tibor@docker.com>
2017-05-10 21:24:32 -04:00
scripts/docs/generate-yaml.sh
Update README and add help target to make Signed-off-by: Jean-Pierre Huynh <jean-pierre.huynh@ounet.fr>
2017-07-19 11:44:39 -04:00
.PHONY: help
help: ## print this help
Makefile: make help: fix newline wrapping, and missing targets This patch adds support for multiple newlines and removes the 1-space indentation of wrapped lines. Given these targets: ```Makefile .PHONY: foobar foobar: ## runs the foobar lorum ipsum.\nand so pn\nand so on echo foobar ``` Before this change, the output of `make help` was ``` foobar runs the foobar lorum ipsum. and so pn\nand so on ``` After this change, the output is: ``` foobar runs the foobar lorum ipsum. and so pn and so on ``` Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-01-10 07:30:03 -05:00
@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z0-9_-]+:.*?## / {gsub("\\\\n",sprintf("\n%22c",""), $$2);printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)