docs: add how-to guide for packing charms in monorepos
Metadata
Current evaluation
Merged into main. PR #2844 added docs/howto/pack-a-charm-in-a-monorepo.rst, linked it from docs/howto/index.rst, updated Charmcraft 4.5 release notes, and added 'monorepos?' to the wordlist, fixing CHARMCRAFT-721.
Resolution: closed resolved
Reason: The documentation PR itself was merged (initial commit fcfd03a4 plus review follow-ups through 4b92f3d2) with all CI checks passing, completing the five-PR monorepo support stack whose feature landed in #2836.
Evaluated by: mr-cal-bot
No scores available.
Issue body
## Description
**Part of Stack:**
1. #2840 (`test(store): replace deleted mysql charmlib with operator-libs-linux.apt in store integration tests`)
2. #2835 (`fix(plugins): use part_build_subdir for charm source copy`)
3. #2842 (`chore(deps): update craft-application to ~=7.2 and fix docs build`)
4. #2836 (`feat: opt into git-driven build root via CHARMCRAFT_EXPERIMENTAL_MONOREPO`)
5. **(this PR: `docs: add how-to guide for packing charms in monorepos`)**
---
Adds documentation for monorepo support in Charmcraft:
- Adds a How-to guide in `docs/howto/pack-a-charm-in-a-monorepo.rst` explaining how to structure monorepos, configure `charmcraft.yaml` with `source: ../..` and `source-subdir`, and pack using `CHARMCRAFT_EXPERIMENTAL_MONOREPO=1`.
- Adds link to the How-to guide in `docs/howto/index.rst`.
- Updates Charmcraft 4.5 release notes in `docs/release-notes/charmcraft-4.5.rst` highlighting Monorepo support under *What's new*.
- Adds `monorepos?` to `docs/.custom_wordlist.txt`.
Fixes CHARMCRAFT-721
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged into main. PR #2844 added docs/howto/pack-a-charm-in-a-monorepo.rst, linked it from docs/howto/index.rst, updated Charmcraft 4.5 release notes, and added 'monorepos?' to the wordlist, fixing CHARMCRAFT-721. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #2844 added a Charmcraft 4.5 guide for packing charms in monorepos, indexed it, and updated release notes, resolving CHARMCRAFT-721. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update adding a how-to guide for packing charms in monorepos, including configuration examples and release notes. Resolves CHARMCRAFT-721 after passing CI checks and receiving two approvals. | |
| qwen/qwen3.8-27b |
Impact:
25
Quick Win:
22
Staleness:
5
Complexity:
10
Confidence:
80
|
needs review | Docs-only PR adding a how-to guide for packing charms in monorepos, an index link, 4.5 release notes, and a wordlist entry. Part of a 5-PR monorepo stack (4 of 5 merged). CI green; 2 reviewers requested changes with 12 unresolved comments; active today. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
5
Complexity:
15
Confidence:
90
|
needs review | Adds documentation and release notes for monorepo charm packing support. Currently pending reviewer feedback with 12 unresolved comments. All CI checks pass. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
5
Complexity:
10
Confidence:
90
|
needs review | Adds documentation and release notes for monorepo support in Charmcraft, including a how-to guide, index link, and wordlist update. Currently pending maintainer review with all CI checks passing. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
10
Complexity:
5
Confidence:
90
|
needs review | Adds documentation and release notes for monorepo support in Charmcraft, including a how-to guide, index update, and wordlist addition. Currently pending maintainer review with all CI checks passing. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
5
Complexity:
5
Confidence:
90
|
needs review | Adds documentation and release notes for monorepo support in Charmcraft, including a how-to guide and configuration examples. CI passes, awaiting maintainer review. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
5
Complexity:
10
Confidence:
90
|
needs review | Adds documentation and release notes for monorepo charm packing support. Currently pending maintainer review with two unresolved comments and passing CI. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
5
Complexity:
10
Confidence:
85
|
needs review | Adds documentation and release notes for monorepo packing support in Charmcraft, including a how-to guide, index link, and wordlist update. Currently pending maintainer review with two unresolved comments, though all CI checks pass. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
5
Complexity:
10
Confidence:
90
|
needs review | Adds documentation and release notes for monorepo support in Charmcraft, including a how-to guide, source configuration examples, and index updates. Currently passing CI, awaiting maintainer review. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
5
Complexity:
10
Confidence:
90
|
needs review | Adds documentation and release notes for monorepo support in Charmcraft. Includes a how-to guide, index update, and wordlist addition. All CI checks pass. Awaiting maintainer review. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
5
Complexity:
15
Confidence:
90
|
needs review | Adds documentation and release notes for monorepo charm packing support. Currently pending maintainer review with two unresolved comments, though all CI checks pass. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
5
Complexity:
5
Confidence:
90
|
needs review | Adds documentation and release notes for experimental monorepo support in Charmcraft. Includes a how-to guide, updates the docs index, and adds a custom word. Currently pending maintainer review with all CI checks passing. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
5
Complexity:
10
Confidence:
90
|
needs review | Adds documentation for monorepo support including a how-to guide, index link, release notes update, and wordlist entry. Currently pending maintainer review with two unresolved comments, though all CI checks pass. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
5
Complexity:
10
Confidence:
90
|
needs review | Adds documentation and release notes for monorepo support in Charmcraft, including a how-to guide and configuration examples. Currently pending maintainer review with all CI checks passing. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
5
Complexity:
15
Confidence:
90
|
needs review | Adds documentation and release notes for monorepo charm packing support. Currently pending maintainer review with 2 unresolved comments and pending CI checks. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
5
Complexity:
10
Confidence:
90
|
needs review | Adds documentation and release notes for monorepo support in Charmcraft, including a new how-to guide and configuration examples. Currently pending maintainer review with passing CI and unresolved comments. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
10
Complexity:
10
Confidence:
90
|
needs review | Adds documentation for monorepo support including a how-to guide, index update, release notes, and wordlist. Currently pending maintainer review with all CI checks passing. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
5
Complexity:
10
Confidence:
90
|
needs review | Adds documentation, release notes, and wordlist updates for monorepo support in Charmcraft. Currently pending maintainer review with all CI checks passing. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
5
Complexity:
15
Confidence:
90
|
needs review | Adds documentation and release notes for monorepo charm packing support, including a how-to guide and configuration examples. Currently pending maintainer review with most CI checks passing. |
Update history
| Date | Change |
|---|---|
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| created |
Related work
-
Related To:
charmcraft#2836
(confidence 96%)
Adds CHARMCRAFT_EXPERIMENTAL_MONOREPO and allow_git_build_root that this guide documents.
-
Related To:
charmcraft#2835
(confidence 85%)
part_build_subdir fix for charm source copy, part of the same monorepo stack.
-
Related To:
charmcraft#2840
(confidence 70%)
Store integration test update listed as part of the monorepo stack.
-
Related To:
charmcraft#2842
(confidence 65%)
craft-application ~=7.2 bump and docs build fix in the same stack.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2801 docs: add Charmcraft 4.4 release notes | charmcraft | merged | Merged docs PR adding Charmcraft 4.4 release notes (commit 82e9de8b, 4 files, +188/-4), landing in docs/release-notes/charmcraft-4.4.rst and indexed in docs/release-notes/index.rst. | |
| #2748 docs: improve charm naming docs, with links to detailed guidance | charmcraft | merged | Docs PR #2748 merged (commit 0389aeb4): rewrote charm naming guidance in the charmcraft.yaml reference and manage-charms how-to, replacing inline best-practice notes with links to the Ops docs. Fixes #2582; relied on canonical/operator#2610. | |
| #471 config: add charm part to documentation (CRAFT-356) | charmcraft | merged | Merged PR #471 via commit e0b18661, documenting the charm part in the configuration schema for CRAFT-356. | |
| #2967 docs: Charmcraft 4.5.0 release notes | charmcraft | merged | Merged PR adding Charmcraft 4.5.0 release notes to the documentation. | |
| #88 docs: add docstrings for the charm build planner | craft-platforms | merged | Merged PR #88, commit 6becdf6, documenting the charm build planner and expanding the README; it fixes #75. | |
| #2589 docs: add Charmcraft 4.2 release notes | charmcraft | merged | Merged: release notes for Charmcraft 4.2 (dated 17 March 2026) added via commit ec9e0727 (+113 lines across docs/release-notes/charmcraft-4.2.rst and the release-notes index). CI failures were pre-existing/unrelated to the docs change. | |
| #2128 docs: add anchors and fix a few small things | charmcraft | merged | Docs PR merged as commit e880b4bd: added intersphinx anchors (e.g. _manage-charms, _initialise-a-charm) for Ops/Juju linking, retitled 'Set up Charmcraft' to 'Manage Charmcraft', expanded content, and fixed a rendering error. | |
| #2582 docs: Guidance on charm naming best practices could be clearer | charmcraft | open | Docs request for clearer charm naming guidance (charm name vs Git repo name) across charmcraft.yaml reference and init how-to. Resolved by merged PR #2748 / commit 0389aeb4, which now links to Ops naming docs. | |
| #2253 docs: add charm docs exemplars links | charmcraft | merged | Merged #2253 as commit 982a6c16, adding links to small and large charm documentation exemplars. | |
| #2299 docs: fix formatting issues | charmcraft | merged | Merged docs formatting fixes for local documentation builds in charmcraft#2299 via commit 5ffb80fe; two files changed (+3/-1). |