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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
|
default:
image: registry.gitlab.com/gitlab-org/gitlab-docs:base
tags:
- gitlab-org
# Check Ruby version and install gems
before_script:
- ruby -v
- NOKOGIRI_USE_SYSTEM_LIBRARIES=1 bundle install --jobs 4 --path vendor
stages:
- build-images
- build
- test
- pre-deploy
- deploy
- post-deploy
#
# Pick the remote branch, by default master (see the Rakefile for more info)
#
variables:
BRANCH_EE: 'master'
BRANCH_OMNIBUS: 'master'
BRANCH_RUNNER: 'master'
BRANCH_CHARTS: 'master'
BUNDLE_PATH__SYSTEM: 'false'
GIT_DEPTH: '20'
#
# Retry a job automatically if it fails (2 times)
#
.retry:
retry: 2
#
# Rules to determine which pipelines jobs will run in.
#
.rules_scheduled:
rules:
- if: '$CI_PIPELINE_SOURCE != "schedule"'
when: never
- if: '$PIPELINE_SCHEDULE_TIMING == "weekly"'
- if: '$PIPELINE_SCHEDULE_TIMING == "hourly"'
when: manual
allow_failure: true
- if: '$CI_COMMIT_BRANCH == "master"'
when: manual
allow_failure: true
.rules_scheduled_manual:
rules:
- if: '$CI_PIPELINE_SOURCE == "schedule"'
when: manual
allow_failure: true
- if: '$CI_COMMIT_BRANCH == "master"'
when: manual
allow_failure: true
.rules_site_tests:
rules:
- if: '$CI_PIPELINE_SOURCE == "schedule"'
- if: '$CI_MERGE_REQUEST_ID'
- if: '$CI_COMMIT_BRANCH == "master"'
- if: '$CI_COMMIT_BRANCH =~ /^\d{1,2}\.\d{1,2}$/'
.rules_prod:
rules:
- if: '$CI_COMMIT_BRANCH == "master"'
- if: '$CI_COMMIT_BRANCH =~ /^\d{1,2}\.\d{1,2}$/'
.rules_pages:
rules:
- if: '$CI_COMMIT_BRANCH == "master"'
.rules_dev:
rules:
- if: '$CI_MERGE_REQUEST_ID'
- if: '$CI_COMMIT_BRANCH =~ /docs-preview/'
#
# Caching keys
#
.cache_gem:
cache:
key:
files:
- Gemfile.lock
paths:
- vendor/ruby
.cache_gem_yarn:
cache:
key:
files:
- Gemfile.lock
- yarn.lock
paths:
- vendor/ruby
- .yarn-cache/
###############################################
# Build the website #
###############################################
.build_base:
image: registry.gitlab.com/gitlab-org/gitlab-docs:bootstrap
stage: build
extends:
- .cache_gem_yarn
- .retry
script:
- yarn install --cache-folder .yarn-cache
- bundle exec rake setup_git default
- bundle exec nanoc compile -VV
# Symlink all README.html to index.html so that we can have clean URLs
- for i in `find public -name README.html`; do ln -sf README.html $(dirname $i)/index.html; done
# Remove CE dir and symlink EE to CE
- if [ $CI_PIPELINE_SOURCE != 'pipeline' ]; then cd public && rm -rf ce && ln -s ee ce && cd ../; fi
# Calculate sizes before and after minifying/gzipping the static files (HTML, CSS, JS)
- SIZE_BEFORE=$(du -sh public/ | awk '{print $1}')
# Minify the assets of the resulting site
- ./scripts/minify-assets.sh ./ public/
- SIZE_AFTER_MINIFY=$(du -sh public/ | awk '{print $1}')
# Use gzip to compress static content for faster web serving
# https://docs.gitlab.com/ee/user/project/pages/introduction.html#serving-compressed-assets
- find public/ -type f \( -iname "*.html" -o -iname "*.js" -o -iname "*.css" -o -iname "*.svg" \) -exec gzip --keep --best --force --verbose {} \;
- SIZE_AFTER_GZIP=$(du -sh public/ | awk '{print $1}')
# Print size results
- echo "Minify and compress the static assets (HTML, CSS, JS)"
- echo
- echo -e "Size before minifying and gzipping ..... $SIZE_BEFORE\nSize after minifying ................... $SIZE_AFTER_MINIFY\nSize after adding gzipped versions ..... $SIZE_AFTER_GZIP"
artifacts:
paths:
- public
expire_in: 1d
#
# Compile only on master and stable branches
#
compile_prod:
extends:
- .rules_prod
- .build_base
variables:
NANOC_ENV: 'production'
#
# Compile on all branches except master
#
compile_dev:
extends:
- .rules_dev
- .build_base
###############################################
# Test the website #
###############################################
#
# Test internal links and anchors with nanoc
#
test_internal_links_and_anchors:
extends:
- .rules_site_tests
- .cache_gem
stage: test
script:
- bundle exec nanoc check internal_links
- bundle exec nanoc check internal_anchors
#
# Run rspec tests
#
rspec:
extends:
- .rules_site_tests
- .cache_gem
needs: []
stage: test
script:
- bundle exec rspec
#
# Run JavaScript tests
#
jest:
extends:
- .rules_site_tests
- .cache_gem_yarn
needs: []
stage: test
script:
- yarn install --cache-folder .yarn-cache
- yarn test
#
# Lint JavaScript
#
js_lint:
extends:
- .rules_site_tests
- .cache_gem_yarn
needs: []
stage: test
script:
- yarn install --cache-folder .yarn-cache
- yarn eslint
- yarn prettier
#
# SCSS linting
#
scss_lint:
extends:
- .rules_site_tests
- .cache_gem
- .retry
needs: []
stage: test
script:
- bundle exec scss-lint
#
# Yamllint of *.yml for .gitlab-ci.yml.
# This uses rules from project root `.yamllint`.
#
yaml_lint:
extends:
- .rules_site_tests
needs: []
stage: test
image: sdesbure/yamllint:latest
before_script: []
script:
- yamllint .gitlab-ci.yml content/_data
#
# Check for broken external links, weekly pipelines only
#
test_external_links:
extends:
- .cache_gem
stage: test
script:
- bundle exec nanoc check external_links
rules:
- if: '$CI_PIPELINE_SOURCE != "schedule"'
when: never
- if: '$PIPELINE_SCHEDULE_TIMING == "weekly"'
allow_failure: true
- if: '$PIPELINE_SCHEDULE_TIMING == "hourly"'
when: manual
allow_failure: true
###############################################
# Review Apps #
###############################################
#
# Deploy the Review App on a dev server
#
review:
stage: deploy
extends:
- .retry
variables:
GIT_STRATEGY: none
needs:
- compile_dev
before_script: []
cache: {}
script:
# Rsync to the Pages dir
- rsync -av --delete public /srv/nginx/pages/$CI_COMMIT_REF_SLUG
# Remove public directory so that the next review app can run in a
# clean environment (limitation of the shell executor).
- rm -rf public
environment:
name: review/$CI_COMMIT_REF_SLUG
url: http://$CI_COMMIT_REF_SLUG.$APPS_DOMAIN
on_stop: review_stop
rules:
- if: '$CI_PROJECT_PATH != "gitlab-org/gitlab-docs"'
when: never
- if: '$CI_MERGE_REQUEST_ID'
- if: '$CI_COMMIT_BRANCH =~ /docs-preview/'
tags:
- nginx
- review-apps
#
# Stop the Review App
#
review_stop:
stage: deploy
extends:
- .retry
variables:
GIT_STRATEGY: none
needs: []
artifacts: {}
before_script: []
cache: {}
script:
- rm -rf public /srv/nginx/pages/$CI_COMMIT_REF_SLUG
environment:
name: review/$CI_COMMIT_REF_SLUG
action: stop
rules:
- if: '$CI_PROJECT_PATH != "gitlab-org/gitlab-docs"'
when: never
- if: '$CI_MERGE_REQUEST_ID || $CI_COMMIT_BRANCH =~ /docs-preview/'
allow_failure: true
when: manual
tags:
- nginx
- review-apps
###############################################
# GitLab Pages (production) #
###############################################
#
# Deploy to production with GitLab Pages
#
pages:
resource_group: pages
extends:
- .rules_pages
- .retry
image: registry.gitlab.com/gitlab-org/gitlab-docs:latest
stage: deploy
variables:
GIT_STRATEGY: none
before_script: []
cache: {}
environment:
name: production
url: https://docs.gitlab.com
# We are using dependencies, because we do not want to
# re-deploy if the previous stages failed.
dependencies:
- compile_prod # Contains the public directory
script:
#
# We want to use the artifacts of the compile_prod job as
# the latest docs deployment, and the other versions are
# taken from /usr/share/nginx/html which are included in
# the image we pull from.
#
- mv /usr/share/nginx/html/1* public/
artifacts:
paths:
- public
expire_in: 1d
###############################################
# Docker images builds #
###############################################
#
# Reuse some common commands
#
.docker_prepare:
extends:
- .retry
image: docker:latest
tags:
- gitlab-org-docker
services:
- docker:19.03.5-dind
before_script:
- docker info
- docker login -u gitlab-ci-token -p $CI_JOB_TOKEN $CI_REGISTRY
#
# GitLab docs lint image containing all test tools
#
image:docs-lint:
extends:
- .rules_scheduled
- .docker_prepare
stage: build-images
variables:
IMAGE_NAME: $CI_REGISTRY_IMAGE:lint
DOCKERFILE: dockerfiles/Dockerfile.gitlab-docs-lint
script:
- docker build --build-arg CI_COMMIT_REF_NAME=${CI_COMMIT_REF_NAME} -t $IMAGE_NAME -f $DOCKERFILE .
- docker push $IMAGE_NAME
environment:
name: registry/docs-lint
#
# GitLab docs image
#
image:gitlab-docs-base:
extends:
- .rules_scheduled_manual
- .docker_prepare
stage: build-images
variables:
IMAGE_NAME: $CI_REGISTRY_IMAGE:base
DOCKERFILE: dockerfiles/Dockerfile.gitlab-docs-base
script:
- docker build -t $IMAGE_NAME -f $DOCKERFILE .
- docker push $IMAGE_NAME
environment:
name: registry/docs-base
#
# Helper Docker image containing all build dependencies.
# It must be rebuilt every time Gemfile and/or Gemfile.lock changes.
#
image:bootstrap:
extends:
- .rules_scheduled
- .docker_prepare
stage: build-images
variables:
IMAGE_NAME: $CI_REGISTRY_IMAGE:bootstrap
DOCKERFILE: dockerfiles/Dockerfile.bootstrap
script:
- docker build -t $IMAGE_NAME -f $DOCKERFILE .
- docker push $IMAGE_NAME
environment:
name: registry/docs-bootstrap
#
# Helper Docker image that builds the gitlab-docs website
#
image:builder-onbuild:
extends:
- .rules_scheduled_manual
- .docker_prepare
stage: build-images
variables:
IMAGE_NAME: $CI_REGISTRY_IMAGE:builder-onbuild
DOCKERFILE: dockerfiles/Dockerfile.builder.onbuild
script:
- docker build -t $IMAGE_NAME -f $DOCKERFILE .
- docker push $IMAGE_NAME
environment:
name: registry/builder-onbuild
#
# Helper Docker image that copies the final HTML files in a smaller image
# (no rubygems included)
#
image:nginx-onbuild:
extends:
- .rules_scheduled_manual
- .docker_prepare
stage: build-images
variables:
IMAGE_NAME: $CI_REGISTRY_IMAGE:nginx-onbuild
DOCKERFILE: dockerfiles/Dockerfile.nginx.onbuild
script:
- docker build -t $IMAGE_NAME -f $DOCKERFILE .
- docker push $IMAGE_NAME
environment:
name: registry/nginx-onbuild
#
# Final Docker image containing a single version
# It is based on Dockerfile.single for each branch
#
image:docs-single:
extends:
- .docker_prepare
stage: pre-deploy
artifacts: {}
cache: {}
dependencies: []
variables:
NANOC_ENV: 'production'
IMAGE_NAME: $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_NAME
DOCKERFILE: Dockerfile.$CI_COMMIT_REF_NAME
environment:
name: registry/$CI_COMMIT_REF_SLUG
script:
- docker build --build-arg NANOC_ENV=${NANOC_ENV} --build-arg CI_COMMIT_REF_NAME=${CI_COMMIT_REF_NAME} -t $IMAGE_NAME -f $DOCKERFILE .
- docker push $IMAGE_NAME
# Only branches with versions like 10.4
rules:
- if: '$CI_COMMIT_BRANCH =~ /^\d{1,2}\.\d{1,2}$/'
#
# Final Docker image containing all the archives
#
image:docs-archives:
extends:
- .rules_scheduled
- .docker_prepare
stage: pre-deploy
artifacts: {}
cache: {}
dependencies: []
variables:
IMAGE_NAME: $CI_REGISTRY_IMAGE:archives
environment:
name: registry/archives
script:
- docker build -t $IMAGE_NAME -f dockerfiles/Dockerfile.archives .
- docker push $IMAGE_NAME
#
# Build master containing the online archives and latest docs (on schedules)
#
image:docs-latest:
extends:
- .rules_scheduled
- .docker_prepare
stage: pre-deploy
artifacts: {}
cache: {}
dependencies: []
variables:
NANOC_ENV: 'production'
IMAGE_NAME: $CI_REGISTRY_IMAGE:latest
DOCKERFILE: Dockerfile.$CI_COMMIT_REF_NAME
environment:
name: registry/latest
script:
- docker build --build-arg NANOC_ENV=${NANOC_ENV} --build-arg CI_COMMIT_REF_NAME=${CI_COMMIT_REF_NAME} -t $IMAGE_NAME -f $DOCKERFILE .
- docker push $IMAGE_NAME
|