chore: add dev workshop - #6263
Open
lengau wants to merge 11 commits into
Open
Conversation
lengau
marked this pull request as draft
May 27, 2026 19:47
lengau
changed the title
- install-branch: Install packages from git branches or URLs Supports both short names (craft-parts) and full URLs Defaults to canonical org for short names - lock: Run uv lock with custom arguments and update setup Automatically runs make setup after locking dependencies Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
lengau
marked this pull request as ready for review
May 27, 2026 19:57
medubelko
reviewed
May 27, 2026
medubelko
left a comment
medubelko
left a comment
Contributor
There was a problem hiding this comment.
Can you include a description and the basic usage in docs/contribute/development.rst? You can mark it with a WIP admonition (!).
lengau
commented
May 27, 2026
Contributor
Author
There was a problem hiding this comment.
medubelko
reviewed
May 27, 2026
| all tools and dependencies pre-installed. It's an alternative to the local | ||
| environment described in the previous section. | ||
|
|
||
| When the workshop starts, it automatically runs ``make setup`` inside the |
Contributor
There was a problem hiding this comment.
How does the user start it?
Contributor
Author
There was a problem hiding this comment.
Added a bit more, and I've ended this section with a link to the Workshop tutorial.
|
|
||
| Two additional helpers support dependency work. | ||
|
|
||
| ``lock`` runs ``uv lock`` with any arguments you pass, then re-runs |
Contributor
There was a problem hiding this comment.
Suggested change
| ``lock`` runs ``uv lock`` with any arguments you pass, then re-runs | |
| The ``lock`` helper runs ``uv lock`` with any arguments you pass, then re-runs |
Contributor
Author
There was a problem hiding this comment.
In the clear light of day I'm changing these to "actions" (including replacing it above).
medubelko
approved these changes
May 28, 2026
bepri
reviewed
May 29, 2026
Comment on lines
+11
to
+12
| lint: make lint | ||
| format: make format |
Member
There was a problem hiding this comment.
My puter 'splodes whenever I try to run either of these:
❯ workshop run -- format
success=true
ruff check --fix snapcraft tests || success=false
ruff format snapcraft tests
$success || exit 1
error: Failed to initialize cache at /var/lib/snapd/void/.ruff_cache: Permission denied (os error 13)
E902 No such file or directory (os error 2)
--> snapcraft:1:1
E902 No such file or directory (os error 2)
--> tests:1:1
Found 2 errors.
error: Failed to initialize cache at /var/lib/snapd/void/.ruff_cache: Permission denied (os error 13)
error: Failed to format snapcraft: No such file or directory (os error 2)
error: Failed to format tests: No such file or directory (os error 2)
make: *** [common.mk:107: format-ruff] Error 2
❯ workshop run -- lint
ruff check snapcraft tests
ruff format --diff snapcraft tests
error: Failed to initialize cache at /var/lib/snapd/void/.ruff_cache: Permission denied (os error 13)
E902 No such file or directory (os error 2)
--> snapcraft:1:1
E902 No such file or directory (os error 2)
--> tests:1:1
Found 2 errors.
make: *** [common.mk:129: lint-ruff] Error 1
mr-cal
approved these changes
Jun 5, 2026
mr-cal
left a comment
mr-cal
left a comment
Collaborator
There was a problem hiding this comment.
Thanks, it works great!
Unless you use worktrees, in which case it doesn't work!! 😠 (worktree bug incoming)
Comment on lines
+86
to
+90
| With the `Workshop Snap <https://snapcraft.io/workshop>`__ installed, start the | ||
| development environment by running ``workshop launch dev`` from within the Snapcraft | ||
| directory. When the workshop starts, it automatically runs ``make setup`` inside the | ||
| container. From there, use the pre-configured actions to carry out common | ||
| development tasks: |
Collaborator
There was a problem hiding this comment.
I think the inline command is easy to skim over when the rest of the commands are code-blocked:
Suggested change
| With the `Workshop Snap <https://snapcraft.io/workshop>`__ installed, start the | |
| development environment by running ``workshop launch dev`` from within the Snapcraft | |
| directory. When the workshop starts, it automatically runs ``make setup`` inside the | |
| container. From there, use the pre-configured actions to carry out common | |
| development tasks: | |
| With the `Workshop Snap <https://snapcraft.io/workshop>`__ installed, start the | |
| development environment from within the Snapcraft directory: | |
| .. code-block:: bash | |
| workshop launch dev | |
| When the workshop starts, it automatically runs ``make setup`` inside the | |
| container. From there, use the pre-configured actions to carry out common | |
| development tasks: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This adds a new
devworkshop for developing snapcraft. Mostly this just uses Workshop to expose the major parts of the Makefile nicely (and of course to set up your workshop), but it also adds two new workshop actions for the dev environment:install-branch: Install packages from git branches or URLs
craft-parts(defaults to canonical org)workshop run -- install-branch craft-parts mainlock: Run uv lock with custom arguments and update setup
make setupafter locking dependenciesworkshop run -- lockorworkshop run -- lock --refreshThese actions improve the dev workflow by making dependency management and testing against branches easier.