devalltect-docs/.github/workflows/pages.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
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
# .github/workflows/pages.yml

name: 🚀 Deploy GitHub Pages

run-name: 🚀 Deploy Documentation • ${{ github.ref_name }}

# =========================================================
# 🚀 GitHub Pages Deployment Workflow
# ---------------------------------------------------------
# Purpose:
# - Build the Docusaurus website
# - Publish generated static files to GitHub Pages
# - Automatically update public documentation
#
# Trigger:
# - Push to main branch
# - Manual execution from GitHub Actions UI
#
# Deployment Flow:
#
# Source Code
# │
# ▼
# yarn install --immutable
# │
# ▼
# yarn build
# │
# ▼
# build/
# │
# ▼
# Upload Pages Artifact
# │
# ▼
# Deploy GitHub Pages
# │
# ▼
# Public Documentation
#
#
# Example URLs
# ---------------------------------------------------------
#
# User Site Repository:
#
# Repository:
# devalltect00.github.io
#
# docusaurus.config.ts:
# url      = https://devalltect00.github.io
# baseUrl  = /
#
# Result:
# https://devalltect00.github.io/
#
#
# Project Site Repository:
#
# Repository:
# devalltect00-docs
#
# docusaurus.config.ts:
# url      = https://devalltect00.github.io
# baseUrl  = /devalltect-docs/
#
# Result:
# https://devalltect00.github.io/devalltect-docs/
#
#
# Required Repository Settings
# ---------------------------------------------------------
#
# GitHub Repository
# → Settings
# → Pages
#
# Build and deployment
# Source:
# GitHub Actions
#
# Do NOT use:
# Deploy from Branch
#
#
# Notes
# ---------------------------------------------------------
# - Docker and Compose are optional local and CI validation tools
# - Pages deployment does not consume the production-preview image
# - No container registry required
# - Release-page automation is handled separately by release.yml
#
# Docusaurus generates a static website.
# GitHub Pages serves the generated files directly.
#
#
# Future Enhancements
# ---------------------------------------------------------
# - Custom domain support
# - Cloudflare integration
# - Lighthouse auditing
# - Link validation workflow
# - Documentation versioning workflow
# =========================================================

on:
  push:
    branches:
      - main

  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: github-pages
  cancel-in-progress: true

jobs:
  build:
    name: 🏗️ Build Documentation

    runs-on: ubuntu-latest

    steps:
      # =====================================================
      # 📥 CHECKOUT
      # =====================================================

      - name: 📥 Checkout repository
        uses: actions/checkout@v4

      # =====================================================
      # 🟢 SETUP NODE.JS
      # =====================================================

      - name: 🟢 Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: "20"

      - name: 🧶 Enable Corepack
        run: corepack enable

      # =====================================================
      # 📦 INSTALL DEPENDENCIES
      # =====================================================

      - name: 📦 Install dependencies
        run: yarn install --immutable

      # =====================================================
      # 🏗️ BUILD DOCUMENTATION
      # =====================================================

      - name: 🏗️ Build documentation
        run: yarn build

      # =====================================================
      # ⚙️ CONFIGURE GITHUB PAGES
      # =====================================================

      - name: ⚙️ Configure GitHub Pages
        uses: actions/configure-pages@v6

      # =====================================================
      # 📤 UPLOAD BUILD ARTIFACT
      # =====================================================

      - name: 📤 Upload GitHub Pages artifact
        uses: actions/upload-pages-artifact@v4
        with:
          path: build

  deploy:
    name: 🚀 Deploy Documentation

    needs: build

    runs-on: ubuntu-latest

    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    steps:
      # =====================================================
      # 🚀 DEPLOY GITHUB PAGES
      # =====================================================

      - name: 🚀 Deploy GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4

      # =====================================================
      # ✅ SUCCESS
      # =====================================================

      - name: ✅ Deployment completed
        run: |
          echo "Documentation successfully deployed."
          echo "URL: ${{ steps.deployment.outputs.page_url }}"