← Back to issue list

docs: document base-specific extension part names

View original Github issue

Metadata

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

Current evaluation

Merged in canonical/rockcraft#1367 via f56e7f6e, documenting slash- versus dot-separated extension part names by Ubuntu base and aligning framework guides, generated comments, and snapshots.

Resolution: closed resolved

Reason: The documentation update was approved with all reported CI checks passing and merged to main as commit f56e7f6e.

Evaluated by: mr-cal-bot

No scores available.

Issue body

Rockcraft generates slash-separated extension part names for Ubuntu 22.04/24.04 and dot-separated names for Ubuntu 26.04 and higher. The 12-factor documentation previously showed only the older syntax, which led to invalid `rockcraft.yaml` customizations for newer bases and paas-charm projects. This updates the framework references and web-app guides with synchronized base tabs and concrete `extension/part` versus `extension.part` guidance. It also documents the Ubuntu 26.04 Flask and Django `app-image` resource name, updates generated profile comments, and keeps the profile snapshots aligned. Validation: - focused `sphinx-lint` checks - full Sphinx dummy build with warnings treated as errors - `pytest -q tests/unit/test_cli.py` (7 passed) - pre-commit hooks --- - [ ] I've followed the [contribution guidelines](https://github.com/canonical/rockcraft/blob/main/CONTRIBUTING.md). - [ ] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/). - [ ] I've successfully run `make lint && make test`. - [x] I've added or updated any relevant documentation. - [x] In documents I changed, I [added a meta description](https://canonical-starflow.readthedocs-hosted.com/how-to/add-a-page-meta-description/) if one was missing. - [ ] I've updated the relevant release notes.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged in canonical/rockcraft#1367 via f56e7f6e, documenting slash- versus dot-separated extension part names by Ubuntu base and aligning framework guides, generated comments, and snapshots.
stealth/space-bunny-alpha — closed resolved Merged in canonical/rockcraft#1367 via commit f56e7f6e, documenting base-specific extension part names and aligning framework guides, generated comments, and profile snapshots.
stealth/space-bunny-alpha
Impact: 43
Quick Win: 20
Complexity: 34
Confidence: 87
Actionability: 72
needs review Documents Ubuntu 26.04+ dot-separated extension part names across guides and updates profile snapshots; approved with no unresolved comments, but source-spread-tests and lint/files checks are failing.
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 26
Staleness: 0
Complexity: 15
Confidence: 75
needs review Documentation update for base-specific extension part names in rockcraft, covering Ubuntu 22.04/24.04 slash-separated and Ubuntu 26.04+ dot-separated syntax. CI failing on source-spread-tests.
qwen/qwen3.6-35b-a3b
Impact: 35
Quick Win: 30
Staleness: 0
Complexity: 15
Confidence: 70
needs review Documentation update for base-specific extension part names, updating framework references and web-app guides with synchronized base tabs and concrete extension/part guidance for Ubuntu 22.04/24.04 vs 26.04+
qwen/qwen3.6-35b-a3b
Impact: 50
Quick Win: 35
Staleness: 0
Complexity: 30
Confidence: 80
needs review Documentation update clarifying base-specific extension part names (slash-separated for 22.04/24.04, dot-separated for 26.04+). All CI checks passing, awaiting maintainer review.

Update history

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

Related issues

Issue Project State Summary Similarity
#1345 extensions: allow part names to use '.' separator for bases that disallow slashes rockcraft merged Merged PR #1345 (approved by 2 reviewers) adds Extension.get_part_name()/ExtensionPart so extension part names use '.' instead of '/' on bases like ubuntu@26.04; applied across expressjs, fastapi, go, flask/django and springboot extensions plus tests.
71%
#1201 docs: add migration note for part names rockcraft merged Merged in canonical/rockcraft#1201 via commit 8410edc7, adding migration guidance for rock part names.
70%