Skip to content

Commit 4bba007

Browse files
committed
docs: add TOPOLOGY.md
1 parent 22ae740 commit 4bba007

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

TOPOLOGY.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<!-- SPDX-License-Identifier: PMPL-1.0-or-later -->
2+
<!-- Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk> -->
3+
# TOPOLOGY.md — a2ml-validate-action
4+
5+
## Purpose
6+
7+
GitHub Action that validates `.a2ml` manifest files in a repository. Checks SPDX headers, required identity/version fields, attestation block structure, and section syntax. Used in CI pipelines across RSR repos to enforce A2ML compliance.
8+
9+
## Module Map
10+
11+
```
12+
a2ml-validate-action/
13+
├── action.yml # GitHub Action metadata and entry point
14+
├── src/
15+
│ └── validate-a2ml.sh # Validation script (delegates to shell logic)
16+
├── examples/ # Example workflows using this action
17+
├── docs/ # Usage documentation
18+
└── container/ # Containerfile for CI
19+
```
20+
21+
## Data Flow
22+
23+
```
24+
[GitHub workflow trigger] ──► [action.yml] ──► [validate-a2ml.sh]
25+
26+
[scan repo for .a2ml files]
27+
28+
[pass / fail with annotations]
29+
```

0 commit comments

Comments
 (0)