devalltect-docs/.gitlab-ci.yml at main · devalltect00/devalltect-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
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
# =========================================================
# 🦊 GitLab CI/CD Pipeline
# =========================================================
#
# Purpose
# -------
# Main GitLab CI/CD entry point.
#
# GitLab automatically discovers ONLY this file.
#
# Additional pipeline definitions are organized into
# smaller files under `.gitlab/` and imported via
# `include`.
#
#
# Architecture
# ------------
#
# .gitlab-ci.yml
# ├── .gitlab/ci.yml
# ├── .gitlab/pages.yml
# ├── .gitlab/docker.yml
# └── .gitlab/release.yml
#
#
# GitHub Equivalent
# -----------------
#
# .github/workflows/
# ├── ci.yml
# ├── pages.yml
# ├── docker.yml
# └── release.yml
#
#
# Responsibilities
# ----------------
# - Documentation Validation
# - Docusaurus Build Verification
# - Docker Image Validation
# - GitLab Pages Deployment
# - Annotated-tag Release Publication
#
#
# Deployment Flow
# ---------------
#
# Documentation Source
# │
# ▼
# Validation (CI)
# │
# ▼
# Build Website
# │
# ▼
# GitLab Pages
#
#
# Notes
# -----
# GitLab:
# - Discovers only `.gitlab-ci.yml`
# - Does NOT automatically discover
# `.gitlab/*.yml`
#
# Therefore all pipeline definitions must be imported
# through this file.
#
#
# Docusaurus-Specific Notes
# -------------------------
# Docker is optional development and validation tooling. The Pages deployments
# continue to publish static output directly. This documentation project does
# not require:
#
# - A container registry
# - Kubernetes deployment
# - Release packaging
# - Container or package publication
#
# Docusaurus generates a static website that can be
# published directly through GitLab Pages.
# Annotated release tags are published separately as GitLab Releases.
#
#
# Future Expansion
# ----------------
# As the documentation portal grows, additional
# pipelines may be added:
#
# .gitlab/
# ├── ci.yml
# ├── pages.yml
# ├── docker.yml
# ├── link-check.yml
# ├── spell-check.yml
# └── versioning.yml
#
#
# =========================================================

stages:
  - test
  - container
  - deploy
  - release

include:
  - local: ".gitlab/ci.yml"
  - local: ".gitlab/docker.yml"
  - local: ".gitlab/pages.yml"
  - local: ".gitlab/release.yml"