feat(templates): improve task template structure #16
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # QA documentation validation — no GitHub Pages deployment. | |
| # Validates API docs (JSDoc + Swagger) and business documentation on qa. | |
| name: Docs QA | |
| on: | |
| push: | |
| branches: [qa] | |
| pull_request: | |
| branches: [qa] | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| # ---------------------------- | |
| # Checkout | |
| # ---------------------------- | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| # ---------------------------- | |
| # Node setup (API docs) | |
| # ---------------------------- | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: "20" | |
| - name: Install backend dependencies | |
| working-directory: backend-api | |
| run: npm ci | |
| # ---------------------------- | |
| # API documentation validation | |
| # ---------------------------- | |
| - name: Generate JSDoc | |
| working-directory: backend-api | |
| run: npm run docs:generate | |
| - name: Generate Swagger UI (static) | |
| working-directory: backend-api | |
| run: npm run docs:swagger-ui | |
| # ---------------------------- | |
| # Business documentation checks | |
| # ---------------------------- | |
| - name: Validate business documentation structure | |
| run: | | |
| echo "Checking business documentation files..." | |
| test -f docs/context-analysis/pestle.md | |
| test -f docs/context-analysis/market_analysis.md | |
| test -f docs/context-analysis/README.md | |
| test -d docs/glossary | |
| test -f docs/glossary/channel_model.md | |
| test -f docs/glossary/monetization.md | |
| test -f docs/glossary/type_of_governance.md | |
| echo "Business documentation structure OK" | |
| # ---------------------------- | |
| # Artifact (manual download) | |
| # ---------------------------- | |
| - name: Upload QA documentation artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: docs-qa | |
| path: | | |
| backend-api/docs/jsdoc | |
| backend-api/docs/api-docs | |
| docs/context-analysis | |
| docs/glossary |