Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add explanation for remote build #4882

Merged
merged 3 commits into from
Jun 28, 2024
Merged

Conversation

mr-cal
Copy link
Collaborator

@mr-cal mr-cal commented Jun 27, 2024

  • Have you followed the guidelines for contributing?
  • Have you signed the CLA?
  • Have you successfully run tox run -m lint?
  • 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)

@mr-cal mr-cal force-pushed the work/CRAFT-3000-documentation branch from cf7510b to 007140f Compare June 27, 2024 22:04
Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
@mr-cal mr-cal force-pushed the work/CRAFT-3000-documentation branch from 007140f to 68bcfd3 Compare June 27, 2024 22:31
@mr-cal mr-cal requested review from tigarmo and mattculler June 28, 2024 12:16
Copy link
Contributor

@tigarmo tigarmo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

docs/explanation/remote-build.rst Outdated Show resolved Hide resolved
docs/explanation/remote-build.rst Outdated Show resolved Hide resolved
docs/explanation/remote-build.rst Show resolved Hide resolved
docs/explanation/remote-build.rst Outdated Show resolved Hide resolved
docs/explanation/remote-build.rst Outdated Show resolved Hide resolved
docs/explanation/remote-build.rst Outdated Show resolved Hide resolved
docs/explanation/remote-build.rst Outdated Show resolved Hide resolved
docs/explanation/remote-build.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@tigarmo tigarmo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm going to preemptively approve this because I have to leave for the weekend! I trust you'll do the right thing ;)

Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
Copy link
Contributor

@mattculler mattculler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellente

docs/explanation/remote-build.rst Outdated Show resolved Hide resolved
docs/explanation/remote-build.rst Outdated Show resolved Hide resolved
Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
@mr-cal mr-cal enabled auto-merge (squash) June 28, 2024 20:39
@mr-cal mr-cal merged commit bd49f8d into main Jun 28, 2024
9 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

remote build: document nuances of current and legacy remote builders
3 participants