Skip to content

Commit bc33da5

Browse files
committed
docs: define source and catalog responsibilities
1 parent cd69c00 commit bc33da5

1 file changed

Lines changed: 17 additions & 5 deletions

File tree

‎docs/architecture.md‎

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@ SPDX-License-Identifier: AGPL-3.0-or-later
77

88
## Responsibility boundary
99

10-
`github-workflows` owns reusable CI and release automation.
10+
`github-workflows` is the source of truth for reusable CI, imported workflow adaptations, generated workflow templates and release automation.
1111

12-
It does not manage repository rulesets. That responsibility belongs to
13-
`LibreCodeCoop/github-governance`.
12+
`LibreCodeCoop/.github` is the organization-facing catalog. Generated workflow templates can be published there so developers can discover them through GitHub's **Actions → New workflow** experience. The catalog is a distribution target, not the editing source.
13+
14+
Repository rulesets remain the responsibility of `LibreCodeCoop/github-governance`.
1415

1516
Consumer repositories own:
1617

@@ -34,11 +35,13 @@ hash verification
3435
↓
3536
explicit downstream patches
3637
↓
37-
generated template
38+
generated `workflow-templates/` artifact
3839
↓
3940
tests + actionlint + zizmor
4041
↓
41-
versioned release
42+
publish catalog copy to `LibreCodeCoop/.github`
43+
↓
44+
versioned release / consumer update
4245
```
4346

4447
The source manifest is authoritative. A network response that does not match the
@@ -61,3 +64,12 @@ Release automation is split into two stages:
6164
- **apply:** explicit mutation and publication.
6265

6366
Credentials remain in the consumer repository or protected environment.
67+
68+
## Developer experience
69+
70+
The distribution model has two complementary entry points:
71+
72+
1. **Discovery / first install:** `LibreCodeCoop/.github/workflow-templates/` provides the GitHub-native template cards, metadata and optional icons.
73+
2. **Ongoing updates:** consumer repositories receive reviewable update pull requests generated from the tested templates in this repository.
74+
75+
When a workflow can be expressed as a thin caller of a reusable workflow, prefer that model because fixes remain centralized. When GitHub Actions semantics require a full installed workflow, publish the generated workflow template and keep its downstream differences as explicit patches here.

0 commit comments

Comments
 (0)