← Back to issue list

docs: add READMEs for each action

View original Github issue

Metadata

Project
craft-actions
Number
#122
Type
pull request
State
closed
Author
bepri
Labels
—
Created
Updated
Closed

Current evaluation

PR #122 (CRAFT-5207) merged into craft-actions: added a README per action plus top-level README update, 15 files changed, approved by 2 reviewers with all completed CI checks passing.

Resolution: closed resolved

Reason: The PR itself was the resolution: it was approved by 2 reviewers with no unresolved review comments and no failed checks (45 passing, 0 failing), then merged and closed, adding per-action READMEs and updating the top-level README.

Evaluated by: mr-cal-bot

No scores available.

Issue body

Following the templates agreed upon earlier, this adds a README to each action + an update to the top-level README. CRAFT-5207 --- <sub>Stack created with <a href="https://github.com/github/gh-stack">GitHub Stacks CLI</a> • <a href="https://gh.io/stacks-feedback">Give Feedback 💬</a></sub>

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved PR #122 (CRAFT-5207) merged into craft-actions: added a README per action plus top-level README update, 15 files changed, approved by 2 reviewers with all completed CI checks passing.
stealth/space-bunny-alpha — closed resolved Merged CRAFT-5207, adding a README for each action and updating the top-level README after two approvals; all completed CI checks passed.
stealth/space-bunny-alpha
Impact: 22
Quick Win: 12
Complexity: 14
Confidence: 72
Actionability: 62
close superseded Docs-only: adds a README to each of the craft actions plus a top-level README update. Approved by 1 reviewer, all CI green except one pending s390x self-hosted check; 3 review threads still unresolved.
stealth/space-bunny-alpha
Impact: 30
Quick Win: 2
Complexity: 15
Confidence: 98
Actionability: 8
close superseded Per-action README split duplicates #46, already merged as 61c29f2; CI is also failing test-action-code and 3 review threads remain unresolved.
stealth/space-bunny-alpha
Impact: 15
Quick Win: 3
Complexity: 12
Confidence: 95
Actionability: 25
close superseded Adds per-action READMEs and revises the top-level README. The split documentation is already covered by merged PR #46; test-action-code is failing and two review comments are unresolved.

Update history

Date Change
closed
updated
updated
updated
updated
updated
updated
updated
updated
created

Related issues

Issue Project State Summary Similarity
#136 docs: consistentize the READMEs craft-actions open Documentation PR making README files across craft-actions consistent. Under review with 5 unresolved comments, CI passing.
82%
#46 docs: split README into one for each action craft-actions merged Merged PR #46 as commit 61c29f2, splitting the monolithic README into per-action READMEs and adopting approved wording from #45.
78%