blob: 7cbf976ffd93f01e0f733f312216c14e6a130f5d (
plain)
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
|
###############################################
# Build and deploy the website #
###############################################
.build_base:
stage: build
extends:
- .retry
- .bundle_and_yarn
script:
- bundle exec rake setup_git default
- bundle exec nanoc compile -VV
# Create _redirects for Pages redirects
- bundle exec rake redirects
# Build the Lunr.js search index if needed
- if [[ "$ALGOLIA_SEARCH" == "false" ]]; then node scripts/lunr/preindex.js; 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
- cd public
- ../scripts/minify-assets.sh ./ ./
- cd ..
- 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" -o -iname "*.json" \) -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 the default and stable branches
#
compile_prod:
extends:
- .rules_prod
- .build_base
variables:
ALGOLIA_SEARCH: 'true'
NANOC_ENV: 'production'
#
# Compile on all branches except the default branch
#
compile_dev:
extends:
- .rules_dev
- .build_base
variables:
ALGOLIA_SEARCH: 'false'
###############################################
# 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$REVIEW_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$REVIEW_SLUG
url: http://$CI_COMMIT_REF_SLUG$REVIEW_SLUG.$APPS_DOMAIN
on_stop: review_stop
rules:
- if: '$CI_PROJECT_PATH == "gitlab-renovate-forks/gitlab-docs"'
when: manual
- if: '$CI_PROJECT_PATH !~ /^gitlab-org/'
when: never
- if: '$CI_MERGE_REQUEST_ID'
- if: '$CI_PIPELINE_SOURCE == "pipeline" || $CI_PIPELINE_SOURCE == "trigger"'
- if: '$CI_COMMIT_BRANCH =~ /docs-preview/' # TODO: Remove once no projects create such branch
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$REVIEW_SLUG
environment:
name: review/$CI_COMMIT_REF_SLUG$REVIEW_SLUG
action: stop
rules:
- if: '$CI_PROJECT_PATH == "gitlab-renovate-forks/gitlab-docs"'
allow_failure: true
when: manual
- if: '$CI_PROJECT_PATH !~ /^gitlab-org/'
when: never
- if: '$CI_MERGE_REQUEST_ID || $CI_PIPELINE_SOURCE == "pipeline"|| $CI_PIPELINE_SOURCE == "trigger"'
allow_failure: true
when: manual
# TODO: Remove once no projects create such branch
- if: '$CI_COMMIT_BRANCH =~ /docs-preview/'
allow_failure: true
when: manual
tags:
- nginx
- review-apps
#
# Clean up review apps and free disk space
#
clean-pages:
stage: deploy
variables:
GIT_STRATEGY: none
needs: []
artifacts: {}
before_script: []
cache: {}
script:
- /home/gitlab-runner/clean-pages ${CLEAN_REVIEW_APPS_DAYS}
- df -h
rules:
- if: '$CI_PIPELINE_SOURCE == "schedule" && $CLEAN_REVIEW_APPS_DAYS'
when: manual
allow_failure: true
tags:
- nginx
- review-apps
#
# Clean up stopped review app environments. Done once a month in a scheduled pipeline,
# only deletes stopped environments that are over 30 days old.
#
delete_stopped_environments:
image: alpine:latest
needs: []
before_script: []
dependencies: []
rules:
- if: $CI_PIPELINE_SOURCE == "schedule" && $PIPELINE_SCHEDULE_TIMING == "monthly"
stage: test
script:
- apk --update add curl jq
- curl --request DELETE "https://gitlab.com/api/v4/projects/1794617/environments/review_apps?dry_run=false&private_token=$DELETE_ENVIRONMENTS_TOKEN" | jq
###############################################
# 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
|
