devalltect-docs/.github/workflows/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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
# .github/workflows/ci.yml

name: 🧪 Continuous Integration

run-name: 🧪 Documentation Validation • ${{ github.ref_name }}

# =========================================================
# 🧪 Continuous Integration Workflow
# ---------------------------------------------------------
# Purpose:
# - Validate documentation changes
# - Ensure TypeScript configuration is valid
# - Ensure Docusaurus builds successfully
# - Detect broken links before deployment
# - Prevent invalid documentation from reaching main
#
# Trigger:
# - Push to:
# main
# develop
# dev
#
# - Pull Requests targeting:
# main
# develop
# dev
#
# - Manual execution from GitHub Actions UI
#
# Why this workflow exists:
# - Docusaurus sites are generated statically
# - Build failures should be caught early
# - Broken links should block merges
# - Invalid MDX should fail CI immediately
#
# Validation Performed:
# - Install Node.js dependencies
# - Run TypeScript validation
# - Build Docusaurus site
#
# Future Enhancements:
# - Markdown linting
# - Link checking
# - Spell checking
# - Documentation quality validation
# =========================================================

on:
  push:
    branches:
      - main
      - develop
      - dev

  pull_request:
    branches:
      - main
      - develop
      - dev

  workflow_dispatch:

permissions:
  contents: read

env:
  DEVALLTECT_HOME_URL: ${{ vars.DEVALLTECT_HOME_URL || 'https://devalltect00.github.io/' }}

jobs:
  validate:
    name: 🧪 Validate Documentation

    runs-on: ubuntu-latest

    strategy:
      fail-fast: false

    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

      # =====================================================
      # 🎨 FORMATTING AND PORTAL TESTS
      # =====================================================

      - name: 🎨 Check formatting
        run: yarn format:check

      - name: 🧪 Test documentation freshness
        run: yarn test

      # =====================================================
      # 🔍 TYPESCRIPT VALIDATION
      # =====================================================

      - name: 🔍 Type Check
        run: yarn typecheck

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

      - name: 🏗️ Build documentation
        run: yarn build

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

      - name: ✅ Validation completed
        run: echo "Documentation validation completed successfully."