dbdocs/.github/workflows/publish-dbdocs.yml at main · glpi-project/dbdocs · 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
name: Publish GLPI Database Documentation

on:
  workflow_dispatch:
  schedule:
    - cron: '0 2 * * 1'

jobs:
  publish-dbdocs:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout dbdocs repository
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.11'

      - name: Install Python dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt

      - name: Set up Node.js
        uses: actions/setup-node@v4
        with:
          node-version: '24'

      - name: Install dbdocs CLI
        run: sudo npm install -g dbdocs

      - name: Verify dbdocs installation
        run: dbdocs --version

      - name: Clone GLPI repository
        run: |
          git clone https://github.com/glpi-project/glpi.git /tmp/glpi
          cd /tmp/glpi
          echo "GLPI repository cloned"

      - name: Checkout GLPI 10.0/bugfixes
        run: |
          cd /tmp/glpi
          git checkout 10.0/bugfixes
          echo "Checked out 10.0/bugfixes branch"

      - name: Generate GLPI 10 schema
        run: |
          python glpi_dbdocs.py generate \
            --sql-file /tmp/glpi/install/mysql/glpi-empty.sql \
            --relation-file /tmp/glpi/inc/relation.constant.php \
            --output docs \
            --output-file glpi-10.dbml

      - name: Checkout GLPI 11.0/bugfixes
        run: |
          cd /tmp/glpi
          git checkout 11.0/bugfixes
          echo "Checked out 11.0/bugfixes branch"

      - name: Generate GLPI 11 schema
        run: |
          python glpi_dbdocs.py generate \
            --sql-file /tmp/glpi/install/mysql/glpi-empty.sql \
            --relation-file /tmp/glpi/inc/relation.constant.php \
            --output docs \
            --output-file glpi-11.dbml

      - name: Checkout GLPI main
        run: |
          cd /tmp/glpi
          git checkout main
          echo "Checked out main branch"

      - name: Generate GLPI Main schema
        run: |
          python glpi_dbdocs.py generate \
            --sql-file /tmp/glpi/install/mysql/glpi-empty.sql \
            --relation-file /tmp/glpi/inc/relation.constant.php \
            --output docs \
            --output-file glpi-main.dbml

      - name: Remove existing dbdocs projects
        if: github.event_name != 'pull_request'
        env:
          DBDOCS_TOKEN: ${{ secrets.DBDOCS_TOKEN }}
        run: |
          dbdocs remove "GLPI 11" || true
          dbdocs remove "GLPI 10" || true
          dbdocs remove "GLPI Main" || true
          dbdocs remove "GLPI 10 to 11" || true
          echo "Removed existing projects (if any)"

      - name: Publish GLPI 11 schema
        if: github.event_name != 'pull_request'
        env:
          DBDOCS_TOKEN: ${{ secrets.DBDOCS_TOKEN }}
        run: |
          dbdocs build docs/glpi-11.dbml --project "GLPI 11"
          echo "Published GLPI 11 schema"

      - name: Publish GLPI 10 schema
        if: github.event_name != 'pull_request'
        env:
          DBDOCS_TOKEN: ${{ secrets.DBDOCS_TOKEN }}
        run: |
          dbdocs build docs/glpi-10.dbml --project "GLPI 10"
          echo "Published GLPI 10 schema"

      - name: Publish GLPI Main schema
        if: github.event_name != 'pull_request'
        env:
          DBDOCS_TOKEN: ${{ secrets.DBDOCS_TOKEN }}
        run: |
          dbdocs build docs/glpi-main.dbml --project "GLPI Main"
          echo "Published GLPI Main schema"

      - name: Publish GLPI 10 to 11 diff schema
        if: github.event_name != 'pull_request'
        env:
          DBDOCS_TOKEN: ${{ secrets.DBDOCS_TOKEN }}
        run: |
          dbdocs build docs/glpi-10.dbml --project "GLPI 10 to 11"
          dbdocs build docs/glpi-11.dbml --project "GLPI 10 to 11"
          echo "Published GLPI 10 to 11 diff schema"

      - name: Upload generated DBML files as artifacts
        uses: actions/upload-artifact@v4
        with:
          name: glpi-dbml-schemas
          path: docs/*.dbml
          retention-days: 30

      - name: Summary
        if: github.event_name != 'pull_request'
        run: |
          echo "## Publication Complete!" >> $GITHUB_STEP_SUMMARY
          echo "" >> $GITHUB_STEP_SUMMARY
          echo "The following GLPI database schemas have been published to dbdocs.io:" >> $GITHUB_STEP_SUMMARY
          echo "" >> $GITHUB_STEP_SUMMARY
          echo "- **GLPI 10** (from 10.0/bugfixes branch)" >> $GITHUB_STEP_SUMMARY
          echo "- **GLPI 11** (from 11.0/bugfixes branch)" >> $GITHUB_STEP_SUMMARY
          echo "- **GLPI Main** (from main branch)" >> $GITHUB_STEP_SUMMARY
          echo "- **GLPI 10 to 11** (comparison view)" >> $GITHUB_STEP_SUMMARY
          echo "" >> $GITHUB_STEP_SUMMARY
          echo "Generated DBML files are available as build artifacts." >> $GITHUB_STEP_SUMMARY