chef-inspec-docs/Makefile at main · inspec/chef-inspec-docs · 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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

bundle:
	npm install

clean_all:
	rm -rf node_modules
	rm -rf resources/
	rm -rf public/
	hugo mod clean

serve: bundle
	hugo server --buildDrafts --noHTTPCache --buildFuture

static: bundle
	hugo --buildDrafts --buildFuture --cleanDestinationDir

metrics: bundle
	hugo --gc --minify --enableGitInfo --templateMetrics --templateMetricsHints

nodrafts: bundle
	hugo server --noHTTPCache --buildFuture

production: bundle
	hugo server --noHTTPCache --environment production

# Override the theme in the _vendor directory and build using locally sourced theme defined in hugo.work file.
# See https://gohugo.io/hugo-modules/use-modules/#module-workspaces
test_theme: bundle
	HUGO_MODULE_WORKSPACE=hugo.work hugo server --buildDrafts --noHTTPCache --buildFuture --ignoreVendorPaths "github.com/chef/chef-docs-theme"

test_theme_branch_deploy: bundle
	HUGO_MODULE_WORKSPACE=hugo.work hugo server --buildDrafts --noHTTPCache --buildFuture --ignoreVendorPaths "github.com/chef/chef-docs-theme" --baseURL http://localhost:1313/inspec/version/ -e branch-deploy

test_theme_static: bundle
	HUGO_MODULE_WORKSPACE=hugo.work hugo --buildDrafts --buildFuture --ignoreVendorPaths "github.com/chef/chef-docs-theme" --cleanDestinationDir

test_branch_deploy: bundle
	hugo server --noHTTPCache --baseURL http://localhost:1313/inspec/version/ -e branch-deploy

serve_ignore_vendor: bundle
	hugo server --buildDrafts --noHTTPCache --buildFuture --ignoreVendorPaths github.com/**

update_theme:
	hugo mod get -u github.com/chef/chef-docs-theme
	rm -rf _vendor node_modules
	hugo mod tidy
	hugo mod vendor
	hugo mod npm pack
	npm install

## See:
## - https://cspell.org/docs/getting-started/
## - https://cspell.org/configuration/
## - and cspell.yaml file.
spellcheck:
	cspell lint **/**/*.md

##
# markdownlint-cli
# See: https://github.com/igorshubovych/markdownlint-cli
##

markdownlint:
	markdownlint "**/*.md" --ignore "node_modules/**" --ignore "public/**" --ignore "_vendor/**" --ignore "archetypes/**" --ignore "resources/**" --ignore "tools/**"

##
# Vale CLI
# See: https://vale.sh/docs
##

vale:
	vale --glob='!{node_modules/**/*,archetypes/**/*,**/README.md,tools/**/*}' *

vale_error:
	vale --no-wrap --filter=error.expr --glob='!{node_modules/**/*,archetypes/**/*,**/README.md,tools/**/*}' *

##
# Hugo Audit
# See: https://gohugo.io/troubleshooting/audit
##

audit:
	HUGO_MINIFY_TDEWOLFF_HTML_KEEPCOMMENTS=true HUGO_ENABLEMISSINGTRANSLATIONPLACEHOLDERS=true hugo --cleanDestinationDir && grep -inorE "<\!-- raw HTML omitted -->|ZgotmplZ|\[i18n\]|\(<nil>\)|(&lt;nil&gt;)|hahahugo" public/

lint: spellcheck markdownlint

lint_all: audit lint