docker-image-example-template/makefile at main · jrwagz/docker-image-example-template · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

# These variables are used for controlling how the image gets tagged when it's built, and they can be overridden when
# the call to the make command is made

# These variables are to easily extract the GitHub owner/name of the repo, using just the remote.origin.url
REMOTE_URL := $(shell git config --get remote.origin.url)
# this parsing of the owner is a bit complex, but it should work for both git and https remotes for github like follows
# https://github.com/jrwagz/docker-image-example-template.git
# git@github.com:jrwagz/docker-image-example-template.git
REPO_OWNER := $(shell echo $(REMOTE_URL) | sed -E -e "s|.*[:/]([a-zA-Z0-9_.-]+)/([a-zA-Z0-9_.-]+)\.git|\1|")
REPO_NAME  := $(shell basename $(REMOTE_URL) .git)
REPO_FULL_NAME := $(REPO_OWNER)/$(REPO_NAME)
IMAGE_NAME := ghcr.io/$(REPO_FULL_NAME)

# Here we default to an image tag that makes it obvious that it was a local build, and that it isn't coming from CI
IMAGE_TAG:=$(shell whoami)-$(shell git describe --always)-dirty

# These variables control what images and tags are used for the various linting tasks
MD_LINT_IMAGE:=ghcr.io/igorshubovych/markdownlint-cli:v0.44.0
DOCKERFILE_LINT_IMAGE:=ghcr.io/hadolint/hadolint:v2.12.0
DIVE_IMAGE:=ghcr.io/wagoodman/dive:v0.13.1
YAML_LINT_IMAGE:=pipelinecomponents/yamllint:0.34.0

# Some of the docker run tasks are better when -it is provided locally, but fail in CI with that value, so here we
# ensure that the appropriate version is available based on where the commands are being executed
IS_TTY := $(shell [ -t 0 ] && echo yes || echo no)
ifeq ($(IS_TTY),yes)
TTY_ARGS := "-it"
else
TTY_ARGS := "-i"
endif


.PHONY: build
build:
	docker build -t $(IMAGE_NAME):$(IMAGE_TAG) .
	docker run --rm $(TTY_ARGS) \
      -v /var/run/docker.sock:/var/run/docker.sock \
      -v  "$(PWD)":"$(PWD)" \
      -w "$(PWD)" \
	  -e CI=true \
      $(DIVE_IMAGE) $(IMAGE_NAME):$(IMAGE_TAG)
	@echo SUCCESS $(IMAGE_NAME):$(IMAGE_TAG) is built and has been scanned by dive

MD_FILES:=$(shell find . -name "*.md")
.PHONY: lint_markdown
lint_markdown:
	docker run --rm $(TTY_ARGS) \
		-v "${PWD}":"${PWD}" \
		-w "${PWD}" \
		$(MD_LINT_IMAGE) $(MD_FILES)

.PHONY: lint_dockerfile
lint_dockerfile:
	docker run --rm -i \
		$(DOCKERFILE_LINT_IMAGE) < Dockerfile

.PHONY: lint_yaml
lint_yaml:
	docker run --rm $(TTY_ARGS) \
		-v "$(PWD)":"$(PWD)" \
		-w "$(PWD)" \
		$(YAML_LINT_IMAGE) yamllint -c .yamllint.yaml .


# Aliases
.PHONY: lint
lint: lint_dockerfile lint_markdown lint_yaml
.PHONY: ready
ready: lint build