← Back to issue list

docs: explain Rockcraft extensions and their usage

View original Github issue

Metadata

Project
rockcraft
Number
#1370
Type
pull request
State
closed
Author
alithethird
Labels
documentation
Created
Updated
Closed

Current evaluation

PR #1370 was closed unmerged after approval; no closing reason or merge commit was recorded, and the files lint check remained pending.

Resolution: closed stale

Reason: The PR received approval from two reviewers, but repository metadata shows it was closed without a merge commit or closing explanation. The only remaining check was lint / files, which was still pending.

Evaluated by: mr-cal-bot

No scores available.

Issue body

## Summary - explain what Rockcraft extensions are and how they modify project configuration - remove the comparison with Snapcraft from the extensions landing page - document the extension declaration, `rockcraft init` profile, and `rockcraft expand-extensions` workflow for every supported framework ## Validation - `sphinx-lint docs/reference/extensions/index.rst docs/reference/extensions/django-framework.rst docs/reference/extensions/express-framework.rst docs/reference/extensions/fastapi-framework.rst docs/reference/extensions/flask-framework.rst docs/reference/extensions/go-framework.rst docs/reference/extensions/spring-boot-framework.rst` - full Sphinx build completed rendering but failed the warning threshold on pre-existing warnings from dependency-provided documentation; no warnings referenced the changed pages Jira: [ISD-6662](https://warthogs.atlassian.net/browse/ISD-6662) [ISD-6662]: https://warthogs.atlassian.net/browse/ISD-6662?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed stale PR #1370 was closed unmerged after approval; no closing reason or merge commit was recorded, and the files lint check remained pending.
stealth/space-bunny-alpha — closed stale Extension documentation PR was closed after approval, but the metadata provides no merge commit or closing explanation; only the files lint check remained pending.
stealth/space-bunny-alpha
Impact: 32
Quick Win: 21
Complexity: 20
Confidence: 82
Actionability: 82
needs review docs: rewrite the extensions landing page to explain what Rockcraft extensions are, drop the Snapcraft comparison, and document declaration, `rockcraft init` profiles and `rockcraft expand-extensions` for all six framework pages. Approved by 2 reviewers, CI green.
stealth/space-bunny-alpha
Impact: 28
Quick Win: 18
Complexity: 12
Confidence: 80
Actionability: 75
needs review Docs-only PR explaining Rockcraft extensions (how they modify rockcraft.yaml, `rockcraft init` profile, `expand-extensions` workflow) across the extensions landing page and six framework references; 2 approvals, 0 open comments, docs lint check still pending.
stealth/space-bunny-alpha
Impact: 28
Quick Win: 12
Complexity: 18
Confidence: 78
Actionability: 52
needs review Docs-only PR (+105/-4, 7 files) explaining Rockcraft extensions, dropping the Snapcraft comparison, and documenting declaration, `rockcraft init` profiles and `expand-extensions` per framework. CI fully green; two reviewers requested changes.
stealth/space-bunny-alpha
Impact: 35
Quick Win: 15
Complexity: 25
Confidence: 88
Actionability: 58
keep open Adds 105 lines documenting framework extension declaration, initialization, and expansion workflows, removing the Snapcraft comparison. All CI checks pass, but two reviewers requested changes.
stealth/space-bunny-alpha
Impact: 24
Quick Win: 10
Complexity: 19
Confidence: 81
Actionability: 54
needs review Adds extension concepts and seven framework guides, including declaration, init, and expand-extensions workflows. All CI passes, but two reviewers requested changes.
qwen/qwen3.6-35b-a3b
Impact: 20
Quick Win: 11
Complexity: 10
Confidence: 75
Actionability: 60
needs review Documentation PR explaining Rockcraft extensions, their declaration, and workflow. All CI passing except diff-schema (unrelated schema check). Awaiting review.

Update history

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

Related issues

Issue Project State Summary Similarity
#1210 fix(commands): reference rockcraft.yaml in extensions help rockcraft closed PR #1210 (fix expand-extensions help to say rockcraft.yaml instead of snapcraft.yaml) was closed unmerged by its author as a duplicate of canonical/rockcraft#1103, which is already approved and CI-passing.
77%
#1117 fix(cli): refer to rockcraft.yaml in expand-extensions help rockcraft closed Docs-only PR correcting the expand-extensions help text to say rockcraft.yaml. Closed unmerged by the author after maintainer @asanvaq noted it duplicated the work in #1103 and #1110; fix still pending in #1103.
75%
#254 docs: include contribution information rockcraft merged Merged contribution documentation updates in rockcraft#254 via commit 24e0c3ab, changing 4 files (+84/-34) and approved by three reviewers.
73%
#454 12f merge rockcraft merged Merged PR canonical/rockcraft#454 into the target branch after maintainer approval, integrating 123 files (+2011/-1422).
73%
#275 Split explanation of ROCKs from Rockcraft itself rockcraft closed ROCK documentation was separated from the Rockcraft overview in merged PR #283 (commit ffdde934), resolving #275.
73%
#1003 docs: add usrmerge explanation rockcraft merged Merged canonical/rockcraft#1003 in commit df630125, adding a dedicated explanation and index entry for Rockcraft's usrmerge conflict handling.
71%
#372 Merge `rockcraft` craft-application merged PR #372 merged into the temporary 2.x branch, adding reviewed rockcraft work and commit ccfe498d's corrected craft-cli/craft-parts constraints for the planned 2.9.0 release.
71%
#682 docs: fix typo rockcraft merged Merged rockcraft#682 (commit 371bc723) fixing a one-line documentation typo; approved by 3 reviewers, CLA signed, merged.
71%
#590 Merge `rockcraft` back into `main` craft-providers merged Merged the rockcraft branch into main via #590 after individual review, adding 2.6.0 changelog entries across six files; approved by two reviewers.
71%
#587 docs: add rockcraft chisel notes craft-parts merged Docs PR approved and merged, landing as canonical/rockcraft#98 (commit 3a87e663): added Chisel explanations and a Rockcraft Parts reference, fulfilling canonical/rockcraft#89.
70%