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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
|
.PHONY: all clean setup test up
INFO = \033[32m
WARN = \033[33m
ERROR = \033[31m
END = \033[0m
PORT := 3000
../gitlab/.git:
@echo "\n$(INFO)INFO: Cloning GitLab project into parent directory...$(END)\n"
@git clone git@gitlab.com:gitlab-org/gitlab.git ../gitlab
../gitlab-runner/.git:
@printf "\n$(INFO)INFO: Cloning GitLab Runner project into parent directory...$(END)\n"
@git clone git@gitlab.com:gitlab-org/gitlab-runner.git ../gitlab-runner
../omnibus-gitlab/.git:
@printf "\n$(INFO)INFO: Cloning Omnibus GitLab project into parent directory...$(END)\n"
@git clone git@gitlab.com:gitlab-org/omnibus-gitlab.git ../omnibus-gitlab
../charts-gitlab/.git:
@printf "\n$(INFO)INFO: Cloning GitLab Chart project into parent directory...$(END)\n"
@git clone git@gitlab.com:gitlab-org/charts/gitlab.git ../charts-gitlab
../gitlab-operator/.git:
@printf "\n$(INFO)INFO: Cloning GitLab Operator project into parent directory...$(END)\n"
@git clone git@gitlab.com:gitlab-org/cloud-native/gitlab-operator.git ../gitlab-operator
clone-all-docs-projects: ../gitlab/.git ../gitlab-runner/.git ../omnibus-gitlab/.git ../charts-gitlab/.git ../gitlab-operator/.git
update-gitlab: ../gitlab/.git
@printf "\n$(INFO)INFO: Stashing any changes, switching to master branch, and pulling updates to GitLab project...$(END)\n"
@cd ../gitlab && git stash && git checkout master && git pull --ff-only
update-gitlab-runner: ../gitlab-runner/.git
@printf "\n$(INFO)INFO: Stashing any changes, switching to main branch, and pulling updates to GitLab Runner project...$(END)\n"
@cd ../gitlab-runner && git stash && git checkout main && git pull --ff-only
update-omnibus-gitlab: ../omnibus-gitlab/.git
@printf "\n$(INFO)INFO: Stashing any changes, switching to master branch, and pulling updates to Omnibus GitLab project...$(END)\n"
@cd ../omnibus-gitlab && git stash && git checkout master && git pull --ff-only
update-charts-gitlab: ../charts-gitlab/.git
@printf "\n$(INFO)INFO: Stashing any changes, switching to master branch, and pulling updates to GitLab Chart project...$(END)\n"
@cd ../charts-gitlab && git stash && git checkout master && git pull --ff-only
update-gitlab-operator: ../gitlab-operator/.git
@printf "\n$(INFO)INFO: Stashing any changes, switching to master branch, and pulling updates to GitLab Operator project...$(END)\n"
@cd ../gitlab-operator && git stash && git checkout master && git pull --ff-only
update-all-docs-projects: update-gitlab update-gitlab-runner update-omnibus-gitlab update-charts-gitlab update-gitlab-operator
up: setup view
check-for-gitlab-content:
@printf "$(INFO)INFO: Checking for GitLab documentation content...$(END)\n"
@if [ -d "../gitlab/doc" ]; then printf "$(INFO)INFO: GitLab documentation exists!$(END)\n"; else printf "$(WARN)WARNING: GitLab documentation is missing.$(END) If unexpected, see <https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/doc/setup.md#troubleshooting> for more information.\n"; fi
check-for-gitlab-runner-content:
@printf "$(INFO)INFO: Checking for GitLab Runner documentation content...$(END)\n"
@if [ -d "../gitlab-runner/docs" ]; then printf "$(INFO)INFO: GitLab Runner documentation exists!$(END)\n"; else printf "$(WARN)WARNING: GitLab Runner documentation is missing.$(END) If unexpected, see <https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/doc/setup.md#troubleshooting> for more information.\n"; fi
check-for-omnibus-gitlab-content:
@printf "$(INFO)INFO: Checking for Omnibus GitLab documentation content...$(END)\n"
@if [ -d "../omnibus-gitlab/doc" ]; then printf "$(INFO)INFO: Omnibus GitLab documentation exists!$(END)\n"; else printf "$(WARN)WARNING: Omnibus GitLab documentation is missing.$(END) If unexpected, see <https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/doc/setup.md#troubleshooting> for more information.\n"; fi
check-for-charts-gitlab-content:
@printf "$(INFO)INFO: Checking for GitLab Charts documentation content...$(END)\n"
@if [ -d "../charts-gitlab/doc" ]; then printf "$(INFO)INFO: GitLab Charts documentation exists!$(END)\n"; else printf "$(WARN)WARNING: GitLab Charts documentation is missing.$(END) If unexpected, see <https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/doc/setup.md#troubleshooting> for more information.\n"; fi
check-for-gitlab-operator-content:
@printf "$(INFO)INFO: Checking for GitLab Operator documentation content...$(END)\n"
@if [ -d "../gitlab-operator/doc" ]; then printf "$(INFO)INFO: GitLab Operator documentation exists!$(END)\n"; else printf "$(WARN)WARNING: GitLab Operator documentation is missing.$(END) If unexpected, see <https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/doc/setup.md#troubleshooting> for more information.\n"; fi
check-for-all-content: check-for-gitlab-content check-for-gitlab-runner-content check-for-omnibus-gitlab-content check-for-charts-gitlab-content check-for-gitlab-operator-content
check-google-search-key:
ifeq ($(GOOGLE_SEARCH_KEY),)
@printf "\n$(INFO)INFO: GOOGLE_SEARCH_KEY environment variable not detected! For more information, see https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/doc/search.md.$(END)\n"
else
@printf "\n$(INFO)INFO: GOOGLE_SEARCH_KEY environment variable detected!$(END)\n"
endif
.PHONY: compile
compile: check-for-all-content
ifeq ($(SEARCH_BACKEND),lunr)
@printf "\n$(INFO)INFO: Compiling GitLab documentation site with Lunr.js search...$(END)\n"
@bundle exec nanoc compile || (printf "$(ERROR)ERROR: Compilation failed! Try running 'make setup'.$(END)\n" && exit 1)
@$(MAKE) --no-print-directory build-lunr-index
else ifeq ($(SEARCH_BACKEND),google)
@printf "\n$(INFO)INFO: Compiling GitLab documentation site with Google Programmable Search...$(END)\n"
@$(MAKE) --no-print-directory check-google-search-key
@bundle exec nanoc compile || (printf "$(ERROR)ERROR: Compilation failed! Try running 'make setup'.$(END)\n" && exit 1)
else ifeq ($(SEARCH_BACKEND),)
@printf "\n$(INFO)INFO: No search backend specified. Compiling GitLab documentation site with Google Programmable Search...$(END)\n"
@$(MAKE) --no-print-directory check-google-search-key
@bundle exec nanoc compile || (printf "$(ERROR)ERROR: Compilation failed! Try running 'make setup'.$(END)\n" && exit 1)
else
@printf "\n$(ERROR)ERROR: Invalid search backend specified!$(END)\n" && exit 1
endif
@printf "\n$(INFO)INFO: Compiling CSS...$(END)\n"
@yarn compile:css
@printf "\n$(INFO)INFO: Compiling JavaScript...$(END)\n"
@ROLLUP_OPTIONS=--silent yarn compile:js
view: compile
@printf "\n$(INFO)INFO: Starting GitLab documentation site...$(END)\n"
@bundle exec nanoc view -p $(PORT)
live: compile
@printf "\n$(INFO)INFO: Starting GitLab documentation site with live reload...$(END)\n"
@bundle exec nanoc live -p $(PORT)
check-asdf:
@printf "\n$(INFO)INFO: Checking asdf is available...$(END)\n"
ifeq ($(shell command -v asdf 2> /dev/null),)
@printf "$(ERROR)ERROR: asdf not found!$(END)\nFor more information, see: https://asdf-vm.com/guide/getting-started.html.$(END)\n"
@exit 1
else
@printf "$(INFO)INFO: asdf found!$(END)\n"
endif
setup-asdf: check-asdf
@printf "\n$(INFO)INFO: Installing asdf plugins...$(END)\n"
@asdf plugin add ruby || true
@asdf plugin add nodejs || true
@asdf plugin add yarn || true
@asdf plugin add shellcheck || true
@asdf plugin add minify || true
@printf "\n$(INFO)INFO: Updating asdf plugins...$(END)\n"
@asdf plugin update ruby
@asdf plugin update nodejs
@asdf plugin update yarn
@asdf plugin update shellcheck
@asdf plugin update minify
install-asdf-dependencies:
@printf "\n$(INFO)INFO: Installing asdf dependencies...$(END)\n"
@asdf install
install-ruby-dependencies:
@printf "\n$(INFO)INFO: Installing Ruby dependencies...$(END)\n"
@gem update --system --no-document
@bundle install
install-nodejs-dependencies:
@yarn install --frozen-lockfile --silent
setup: clean brew-bundle setup-asdf install-asdf-dependencies install-ruby-dependencies install-nodejs-dependencies
update:
@printf "\n$(INFO)INFO: Stashing any changes, switching to main branch, and pulling updates to GitLab Docs project...$(END)\n"
@git stash && git checkout main && git pull --ff-only
update-all-projects: update update-all-docs-projects
clean:
@printf "\n$(INFO)INFO: Removing tmp and public directories...$(END)\n"
@rm -rf tmp public
build-lunr-index:
@printf "\n$(INFO)INFO: Building offline search index...$(END)\n"
@node scripts/lunr/preindex.js
@find public/assets/javascripts -type f -name 'lunr*.json' -exec sh -c 'gzip -c "{}" > "{}.gz"' \;
check-lunr-index:
@printf "\n$(INFO)INFO: Checking if lunr.js is enabled...$(END)\n"
@scripts/check-lunr-index.sh
internal-links-check: clone-all-docs-projects compile
@printf "\n$(INFO)INFO: Checking all internal links...$(END)\n"
@bundle exec nanoc check internal_links
internal-anchors-check: clone-all-docs-projects compile
@printf "\n$(INFO)INFO: Checking all internal anchors...$(END)\n"
@bundle exec nanoc check internal_anchors
internal-links-and-anchors-check: clone-all-docs-projects compile
@printf "\n$(INFO)INFO: Checking all internal links and anchors...$(END)\n"
@parallel bundle exec nanoc check ::: internal_links internal_anchors
external-links-check: compile
@printf "\n$(INFO)INFO: Checking all external links...$(END)\n"
@bundle exec nanoc check external_links
brew-bundle:
@printf "\n$(INFO)INFO: Checking Brew dependencies, if Brew is available...$(END)\n"
@(command -v brew > /dev/null 2>&1) && brew bundle --no-lock || true
rspec-tests:
@printf "\n$(INFO)INFO: Running RSpec tests...$(END)\n"
@bundle exec rspec
jest-tests:
@printf "\n$(INFO)INFO: Running Jest tests...$(END)\n"
@yarn test
@yarn test:vue3
eslint-tests:
@printf "\n$(INFO)INFO: Running ESLint tests...$(END)\n"
@yarn eslint
prettier-tests:
@printf "\n$(INFO)INFO: Running Prettier tests...$(END)\n"
@yarn prettier
rubocop-tests:
@printf "\n$(INFO)INFO: Running RuboCop tests...$(END)\n"
@bundle exec rubocop
stylelint-tests:
@printf "\n$(INFO)INFO: Running Stylelint tests...$(END)\n"
@yarn stylelint content/assets/stylesheets
hadolint-tests:
@printf "\n$(INFO)INFO: Running hadolint tests...$(END)\n"
@hadolint latest.Dockerfile .gitpod.Dockerfile **/*.Dockerfile
yamllint-tests:
@printf "\n$(INFO)INFO: Running yamllint tests...$(END)\n"
@yamllint .gitlab-ci.yml .gitpod.yml .devfile.yaml content/_data
markdownlint-tests:
@printf "\n$(INFO)INFO: Running markdownlint tests...$(END)\n"
@yarn markdownlint-cli2 doc/**/*.md
markdownlint-whitespace-tests-gitlab:
@printf "\n$(INFO)INFO: Running markdownlint whitespace tests on GitLab project...$(END)\n"
@cd ../gitlab/doc && markdownlint-cli2-config "../../gitlab-docs/tasks/.markdownlint.yml" "**/*.md"
markdownlint-whitespace-tests-gitlab-runner:
@printf "\n$(INFO)INFO: Running markdownlint whitespace tests on GitLab Runner project...$(END)\n"
@cd ../gitlab-runner/docs && markdownlint-cli2-config "../../gitlab-docs/tasks/.markdownlint.yml" "**/*.md"
markdownlint-whitespace-tests-omnibus-gitlab:
@printf "\n$(INFO)INFO: Running markdownlint whitespace tests on Omnibus GitLab project...$(END)\n"
@cd ../omnibus-gitlab/doc && markdownlint-cli2-config "../../gitlab-docs/tasks/.markdownlint.yml" "**/*.md"
markdownlint-whitespace-tests-charts-gitlab:
@printf "\n$(INFO)INFO: Running markdownlint whitespace tests on GitLab Chart project...$(END)\n"
@cd ../charts-gitlab/doc && markdownlint-cli2-config "../../gitlab-docs/tasks/.markdownlint.yml" "**/*.md"
markdownlint-whitespace-tests-gitlab-operator:
@printf "\n$(INFO)INFO: Running markdownlint whitespace tests on GitLab Operator project...$(END)\n"
@cd ../gitlab-operator/doc && markdownlint-cli2-config "../../gitlab-docs/tasks/.markdownlint.yml" "**/*.md"
markdownlint-whitespace-tests: install-nodejs-dependencies
@$(MAKE) markdownlint-whitespace-tests-gitlab || true
@$(MAKE) markdownlint-whitespace-tests-gitlab-runner || true
@$(MAKE) markdownlint-whitespace-tests-omnibus-gitlab || true
@$(MAKE) markdownlint-whitespace-tests-charts-gitlab || true
@$(MAKE) markdownlint-whitespace-tests-gitlab-operator || true
shellcheck-tests:
@printf "\n$(INFO)INFO: Running shellcheck tests...$(END)\n"
@shellcheck scripts/*.sh tasks/*.sh
check-global-navigation:
@printf "\n$(INFO)INFO: Checking global navigation...$(END)\n"
@scripts/check-navigation.sh
check-pages-not-in-nav: install-nodejs-dependencies
@scripts/pages_not_in_nav.js | jq
check-danger:
@printf "\n$(INFO)INFO: Checking for Danger errors and warnings...$(END)\n"
@scripts/check-danger.sh ; exit $$?
create-stable-branch:
@printf "\n$(INFO)INFO: Creating stable branch...$(END)\n"
@bundle exec rake release:single
test: setup rspec-tests jest-tests eslint-tests prettier-tests stylelint-tests hadolint-tests yamllint-tests markdownlint-tests check-global-navigation
|
