docs: add explanation for remote build
Metadata
Current evaluation
Merged documentation update detailing current and legacy remote builder behaviors. Approved by reviewers and passed CI. Resolves issue #4842 by establishing comprehensive guidance prior to future behavioral changes.
Suggested action: —
No scores available.
Issue body
- [x] Have you followed the [guidelines for contributing](https://github.com/snapcore/snapcraft/blob/master/CONTRIBUTING.md)?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] Have you successfully run `tox run -m lint`?
- [x] Have you successfully run `tox run -e test-py310`? (supported versions: `py39`, `py310`, `py311`, `py312`)
-----
This PR explains how the current and legacy remote builders behave.
The behavior of the new and legacy remote builders is nuanced enough that we need comprehensive documentation before we can comfortably make behavioral changes.
Preview here: https://canonical-snapcraft--4882.com.readthedocs.build/en/4882/explanation/remote-build.html
Fixes #4842
(CRAFT-3000)
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update detailing current and legacy remote builder behaviors. Approved by reviewers and passed CI. Resolves issue #4842 by establishing comprehensive guidance prior to future behavioral changes. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update clarifying current and legacy remote builder behavior to establish a baseline before future modifications. Resolves #4842. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update explaining current and legacy remote builder behavior. Resolves issue #4842 by providing comprehensive guidance to safely implement future behavioral changes. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #778 docs: reference docs for remote builds | rockcraft | merged | 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. | |
| #2702 docs: add common remote build pages | charmcraft | merged | Merged after being held in draft pending a hotfix. Added how-to and reference documentation for common remote builds. Approved by two reviewers and passed CI checks. | |
| #800 docs: add remote-build how-to | rockcraft | merged | Merged documentation update adding a remote-build how-to guide. Approved by three reviewers, the change adds 152 lines across three files detailing remote build procedures. | |
| #802 docs: add remote build how-to to 1.8.0 release notes | rockcraft | merged | Merged documentation update adding a remote build how-to guide to the 1.8.0 release notes. Approved by one reviewer, passed CI checks, and modified one file with 13 additions and 4 deletions. | |
| #4432 fix(remote-build): improve logging and catch exceptions | snapcraft | merged | Merged pull request improving remote build logging and exception handling. Approved by reviewers, passed CI checks, and resolves issue #4399. | |
| #746 docs: add remote build how-to and reference docs | craft-application | merged | Merged documentation update adding remote build how-to and reference guides alongside a new common docs module. Approved by three reviewers and passed CI checks despite one failing snap-test. Modified 11 files with 411 additions and 6 deletions. | |
| #5293 docs(release-notes): update remote-build notes | snapcraft | merged | Merged documentation update correcting release notes. Removed remote-build feature mention from version 8.7 as it is scheduled for 8.8. Approved by two reviewers, passed CI, and modified one file. | |
| #2642 remote-build: detect early build errors | snapcraft | merged | Merged. Improved remote build error detection to distinguish between pending builders and actual failures like missing config or timeouts. Approved by reviewer, passed CI, and modified 3 files (+131/-47 lines). Minor import fix applied. | |
| #4395 feat(remote-build): new command logic | snapcraft | merged | Merged into main. Introduces a RemoteBuild class to orchestrate remote builds, adds local project directory caching, and implements post-build cache cleanup. Resolves #4324. Approved by three reviewers with passing CI and 97.88% diff coverage. | |
| #1003 docs: Add reference documentation for the RemoteBuildService | craft-application | open | Adds 121 lines of reference documentation for RemoteBuildService across 2 files. CI passing, no reviews or comments. Author is a maintainer. Service still exists in codebase; target docs file not yet in main. |