blob: 885008329f2ef851a91ed72ea26b826f3b91403e (
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
52
53
54
55
56
57
58
59
|
name: UML
on:
pull_request:
workflow_dispatch:
permissions:
contents: write
jobs:
blueprint:
runs-on: ubuntu-latest
steps:
- name: Checkout PR branch
uses: actions/checkout@v4
with:
# Check out the PR's source branch (not the detached merge commit) so
# the regenerated diagram can be pushed straight back to it.
ref: ${{ github.head_ref }}
- name: Install Nix
uses: cachix/install-nix-action@v27
- name: Generate PlantUML blueprint
# --strict fails the job if a @uses/@needs tag names an unknown module.
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 blueprint artifact
uses: actions/upload-artifact@v4
with:
name: architecture-diagram
path: |
docs/architecture.puml
docs/architecture.svg
- name: Commit updated diagram to the PR branch
# Only same-repo PRs can be pushed to; fork PRs get the artifact instead.
if: >-
github.event_name == 'pull_request' &&
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 "diagram unchanged — nothing to commit"
else
# [skip ci] stops this auto-commit from retriggering the workflow;
# the diff guard above stops it once the diagram stabilises.
git commit -m "ci: update architecture diagram [skip ci]"
git push origin HEAD:${{ github.head_ref }}
fi
|
