← Back to issue list

docs(README): Replace obsoleted build command

View original Github issue

Metadata

Project
charmcraft
Number
#817
Type
pull request
State
merged
Author
merkata
Labels
—
Created
Updated
Closed

Current evaluation

Merged PR #817 updated the README to use charmcraft pack instead of the removed charmcraft build command for Charmcraft 2.0.0.

Resolution: closed resolved

Reason: PR #817 was merged in commit 902f6c37, correcting two obsolete README command examples.

Evaluated by: mr-cal-bot

No scores available.

Issue body

The README refers to the process of building a charm by invoking `charmcraft build`, but that command is (no longer) available. Looking at the code, a transition is being made from build.py to pack.py and the command to build the charm is also `pack`. I've renamed it to reflect this for the current version (2.0.0).

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged PR #817 updated the README to use charmcraft pack instead of the removed charmcraft build command for Charmcraft 2.0.0.
stealth/space-bunny-alpha — closed resolved PR #817 updated README instructions from the removed charmcraft build command to charmcraft pack for Charmcraft 2.0.0; merged in commit 902f6c37.
stealth/space-bunny-alpha — closed resolved Merged doc-only fix (commit 902f6c37 / aa8e94a6): README no longer tells users to run the removed `charmcraft build` command and instead documents `charmcraft pack`, matching Charmcraft 2.0.0.
stealth/space-bunny-alpha — closed resolved README now uses charmcraft pack instead of the removed charmcraft build command, matching Charmcraft 2.0.0; merged via PR #817 in commit 902f6c37.
qwen/qwen3.6-35b-a3b — — Merged an external contribution updating the README to replace the obsolete charmcraft build command with pack, reflecting the transition to pack.py in version 2.0.0. Approved by one reviewer, passed CI, and modified one file.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation update replacing the obsolete charmcraft build command with charmcraft pack in the README, reflecting the transition from build.py to pack.py in version 2.0.0.

Update history

No update history recorded yet.

Related work

  • Caused By: charmcraft#798 (confidence 90%)

    Merged in commit 2da73fb8 and removed the long-deprecated build command, leaving README examples outdated.

Related issues

Issue Project State Summary Similarity
#2154 docs: replace occurrences of "charmcraft.yaml" and "recipe" charmcraft merged Merged PR #2154 (a6ccb3d4) updated 23 documentation files to use “project” or “project file” instead of “charmcraft.yaml” and “recipe.”
75%
#664 Deprecate the `build` command charmcraft closed Charmcraft 1.5 deprecated `build` through merged PR #683 (commit ae230370), adding a notice directing users to `pack`.
75%
#720 `charmcraft --help` still mentions `build` that is deprecated charmcraft closed Fixed in canonical/charmcraft#739 (commit 1a461c39): removed deprecated build from top-level help and promoted pack as the standard build command.
75%
#2186 docs: fix build errors charmcraft merged Merged as charmcraft/charmcraft#2186 in commit 42f42bd2, fixing the targeted docs build error. Remaining transclusion problems were addressed separately in canonical/craft-parts#1021.
74%
#1341 [JUJU-4554] Update the README to simplify and better align with docs charmcraft merged Docs-only PR merged as commit 647a605c (#1341): rewrote Charmcraft's README (+62/-118) to a shorter intro placing Charmcraft in the Juju/Charm SDK ecosystem and linking to Charm SDK docs instead of Multipass install steps.
73%
#2496 docs: add Charmcraft 4.1 release notes charmcraft closed Closed as a duplicate after the Charmcraft 4.1 release notes were merged through canonical/charmcraft#2483 in commit b742f96c.
72%
#2967 docs: Charmcraft 4.5.0 release notes charmcraft merged Merged PR adding Charmcraft 4.5.0 release notes to the documentation.
72%
#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.
72%
#143 New release (and improved howto). charmcraft merged Merged in charmcraft#143 (change d5570668, merge 90ae3562), releasing Charmcraft 0.4.0 and improving the release how-to documentation.
72%
#2795 docs: improve `charmcraft clean` command documentation charmcraft closed Closed unmerged; maintainer @lengau rejected the proposed charmcraft clean documentation as subpar, and no documentation commit or replacement PR landed.
72%