docs: reference docs for remote builds
Metadata
Current evaluation
Merged via rockcraft#778 (commit e5b9bda3): added docs/reference/remote-builds.rst plus a Launchpad remote-build how-to, fixing issue #597. Later refined by #1012, #1118 and metadata pass #1246.
Resolution: closed resolved
Reason: The PR was approved and merged into main as commit e5b9bda3, adding the remote-build reference docs and how-to guide, and explicitly closes issue #597 per the PR body ("Fixes #597").
Evaluated by: mr-cal-bot
No scores available.
Issue body
This is loosely inspired on the existing docs for Snapcraft, but with a different set of restrictions and no concerns about 'legacy' versus 'new' builders.
Note that this is complementary to the command reference that is autogenerated from the Python code.
Fixes #597
- [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
-----
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged via rockcraft#778 (commit e5b9bda3): added docs/reference/remote-builds.rst plus a Launchpad remote-build how-to, fixing issue #597. Later refined by #1012, #1118 and metadata pass #1246. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged via rockcraft#778 (commit e5b9bda3), adding remote-build reference and how-to documentation and fixing #597. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update adding reference guides for remote builds, complementing autogenerated command docs and resolving issue #597. Approved with minor template discussion. Changes add 51 lines across two files. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged reference documentation for remote builds, complementing autogenerated command references. Approved by reviewer, closing issue #597. Discussed potential RST template substitutions for app names. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/rockcraft#1012
(confidence 80%)
Later commit 'docs: maintain reference quadrant (#1012)' touched docs/reference/remote-builds.rst
-
Related To:
canonical/rockcraft#1118
(confidence 80%)
Commit 'docs: link reference to building remotely how-to (#1118)' updated the linked how-to page
-
Related To:
canonical/rockcraft#1246
(confidence 75%)
Commit 'docs: add metadata to all remaining pages (#1246)' later touched both new doc pages
-
Likely Fixed By:
canonical/rockcraft#597
(confidence 70%)
PR body states 'Fixes #597'; issue tracker lookup for #597 returned a different (Bases docs) record, so the link is from the PR text only
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #800 docs: add remote-build how-to | rockcraft | merged | Merged docs PR canonical/rockcraft#800 (commit a07a6e6a) adding a remote-build how-to guide, +152 lines across 3 docs files, documenting the experimental `rockcraft remote-build` command. | |
| #1118 docs: link corresponding reference to building remotely how-to | rockcraft | merged | Docs-only PR #1118 merged as commit b560404b, adding a cross-reference from the Launchpad how-to guide to the remote-builds reference page, addressing user feedback from UR sessions. | |
| #802 docs: add remote build how-to to 1.8.0 release notes | rockcraft | merged | Merged PR #802 via commit dc39bba8, adding a remote-build how-to reference to the Rockcraft 1.8.0 release notes. | |
| #597 Document the remote-build command | craft-application | closed | Documentation for `remote-build` added in merged PR #746 (commit 2c32b1ae): new how-to `build-remotely.rst` and reference `remote-builds.rst` covering experimental status, Launchpad workflow, and restrictions. Issue closed as completed. | |
| #4882 docs: add explanation for remote build | snapcraft | merged | PR #4882 (mr-cal) merged as commit bd49f8db0, adding docs/explanation/remote-build.rst plus index entries to explain current and legacy remote builders; closes documentation issue #4842 (CRAFT-3000). | |
| #746 docs: add remote build how-to and reference docs | craft-application | merged | Merged PR #746 added a common documentation module plus generic remote-build how-to and reference guides for Craft Application. | |
| #769 feat: add the remote-build command | rockcraft | merged | Merged PR #769 via commit 8e74936f, adding Rockcraft's experimental remote-build command; documentation followed in PRs #800 and #802. | |
| #2592 Add remote-build documentation | charmcraft | closed | Remote-build how-to and reference documentation was added by merged PR canonical/charmcraft#2702 (commit a54f9ac0) and released in Charmcraft 4.2. | |
| #2702 docs: add common remote build pages | charmcraft | merged | Merged PR #2702 in commit a54f9ac0, adding remote-build how-to and reference pages that closed #2592 and shipped in Charmcraft 4.2. | |
| #1185 docs: rework remote build guide | craft-application | closed | Merged in commit 4c49d82b (#1185), recommending Launchpad’s web UI by default and simplifying the remote-build guide. |