Skip to content

Commit 95038fd

Browse files
committed
docs: explain release planner action boundary
1 parent d34f21b commit 95038fd

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

‎docs/nextcloud-release.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,23 @@ The reusable release-plan workflow is intentionally non-mutating. It validates
99
release prerequisites before any tag, GitHub Release, signing or App Store
1010
publication occurs.
1111

12+
## Architecture
13+
14+
The reusable workflow owns orchestration concerns: permissions, runner selection
15+
and checking out the caller plus the workflow tooling repository.
16+
17+
The release-plan operation itself is exposed as the local composite action
18+
`actions/release-plan`. The action maps its declared inputs to a small,
19+
namespaced environment contract and invokes `scripts/release_plan.py`.
20+
21+
Business rules, input parsing, GitHub API checks, exit status and step-summary
22+
rendering live in the Python script and are covered by unit tests. The workflow
23+
does not contain release decision logic.
24+
25+
This follows GitHub's distinction between reusable workflows, which reuse whole
26+
workflow/job structures, and composite actions, which encapsulate a reusable
27+
sequence of steps within a job.
28+
1229
## Checks
1330

1431
The first implementation validates:

0 commit comments

Comments
 (0)