aboutsummaryrefslogtreecommitdiffstats
path: root/.github/workflows/uml.yml
blob: 2d946e807857b43f6168d3fdb914496069b09d5f (plain) (blame)
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
name: UML

on:
  pull_request:

permissions:
  contents: write

jobs:
  blueprint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          ref: ${{ github.head_ref }}

      - uses: cachix/install-nix-action@v27

      - name: Run tests
        run: nix develop --command dune test

      - name: Generate blueprint
        run: |
          nix shell nixpkgs#perl --command \
            perl tools/uml_blueprint.pl --src lib --out docs/architecture.puml --strict --no-notes

      - name: Render diagram
        run: |
          nix shell nixpkgs#plantuml --command \
            plantuml -tsvg docs/architecture.puml

      - name: Upload artifact
        uses: actions/upload-artifact@v4
        with:
          name: architecture-diagram
          path: |
            docs/architecture.puml
            docs/architecture.svg

      - name: Commit diagram to the PR branch
        if: github.event.pull_request.head.repo.full_name == github.repository
        run: |
          git config user.name  "github-actions[bot]"
          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
          git add docs/architecture.puml docs/architecture.svg
          if git diff --cached --quiet; then
            echo "unchanged"
          else
            git commit -m "ci: update architecture diagram [skip ci]"
            git push origin HEAD:${{ github.head_ref }}
          fi