Add Structurizr state files to .gitignore #17
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
| name: CI - Tests and Architecture Validation | |
| on: | |
| push: | |
| branches: [ main, dev ] | |
| pull_request: | |
| branches: [ main, dev ] | |
| jobs: | |
| test: | |
| name: Run Tests | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Set up Python 3.12 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.12' | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -r requirements.txt | |
| pip install pytest pytest-cov | |
| - name: Run tests with coverage | |
| run: | | |
| pytest tests/ -v --cov=app --cov-report=term-missing | |
| validate-architecture: | |
| name: Validate C4 Annotations | |
| runs-on: ubuntu-latest | |
| needs: test | |
| steps: | |
| - name: Checkout notes-api | |
| uses: actions/checkout@v4 | |
| - name: Set up Python 3.12 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.12' | |
| - name: Install c4-literate-python | |
| run: | | |
| # For now, install from local path or git repo | |
| # Replace with: pip install c4-literate-python | |
| # once published to PyPI | |
| pip install git+https://github.com/ChristosDev75/c4-literate-python.git@main | |
| - name: Validate C4 annotations | |
| run: | | |
| c4-literate validate . | |
| - name: Generate architecture diagrams | |
| run: | | |
| mkdir -p docs/architecture | |
| c4-literate tangle . -o docs/architecture/workspace.dsl | |
| - name: Upload generated DSL | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: architecture-diagrams | |
| path: docs/architecture/workspace.dsl | |
| retention-days: 90 | |
| - name: Comment PR with artifact link | |
| if: github.event_name == 'pull_request' | |
| uses: actions/github-script@v7 | |
| with: | |
| script: | | |
| github.rest.issues.createComment({ | |
| issue_number: context.issue.number, | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| body: '✅ Architecture diagrams generated successfully! Download the artifact to view with Structurizr Lite.' | |
| }) |