← Back to issue list

Snapcraft should provide an `tour` subcommand that sets up a basic tour

View original Launchpad issue

Metadata

Project
snapcraft (launchpad)
Number
#1586137
Type
issue
State
closed
Author
~kyrofa
Labels
verification-done
Created
Updated
Closed

Current evaluation

Implemented in Snapcraft 2.10: PR #513 (7f334a5b1) added the getting-started tour, and PR #559 (cadeb87ea) re-enabled the completed command; verification passed.

Resolution: closed resolved

Reason: PR #513 merged as 7f334a5b1 added scaffolded tour examples and tests; follow-up PR #559 merged as cadeb87ea re-enabled the tour command. Snapcraft 2.10.1 was released with verification-done, and maintainer @elopio confirmed there was nothing further to test.

Evaluated by: mr-cal-bot

No scores available.

Issue body

The snapcraft codebase currently includes a number of examples that are more suited to be demos. Snapcraft should include a number of very simple examples that can be created on the fly in order to walk though introductory documentation. These examples should be created in the current working directory via `snapcraft examples`. [Impact] * A tour will help users getting started with snapcraft. [Test Case] * Follow the tour docs and instructions. [Regression Potential] * New tests were added for the tour snaps, and the old examples tests were renamed. If they fail, they will block the package getting to proposed.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Implemented in Snapcraft 2.10: PR #513 (7f334a5b1) added the getting-started tour, and PR #559 (cadeb87ea) re-enabled the completed command; verification passed.
stealth/space-bunny-alpha — closed resolved Added introductory tour scaffolding in PR #513 (7f334a5b1); PR #559 (cadeb87ea) re-enabled the command, and the fix shipped in snapcraft 2.10.1.
stealth/space-bunny-alpha — closed resolved Added snapcraft examples to scaffold introductory demos; PR #513 merged as 7f334a5b1, with tour/example tests enabling the getting-started walkthrough.
qwen/qwen3.6-35b-a3b — — Implemented and verified. Added a snapcraft tour subcommand to generate basic example snaps for documentation walkthroughs. Tests were updated to cover the new functionality, and the feature passed verification.
qwen/qwen3.6-35b-a3b — — Implemented and verified. Added a snapcraft tour subcommand to generate introductory example snaps locally, improving the user onboarding workflow.
qwen/qwen3.6-35b-a3b — — Implemented and merged the tour subcommand for Snapcraft, allowing users to generate simple example snaps for documentation. Marked verification-done.
qwen3.6-35b-a3b-mtp-q6 — — Implemented and verified. Added a tour subcommand to Snapcraft to generate introductory examples, replacing legacy demos. Test suite updated and regression checks passed.

Update history

Date Change
created

Related work

  • Likely Fixed By: snapcraft#513 (confidence 99%)

    Merged commit 7f334a5b1 added the getting-started tour examples and tests.

  • Likely Fixed By: snapcraft#559 (confidence 99%)

    Merged commit cadeb87ea re-enabled the completed tour command.

  • Related To: snapcraft#522 (confidence 95%)

    Merged commit e58d857ee moved the older examples to demos as tour development progressed.

Related issues

Issue Project State Summary Similarity
#1590906 Enable the `snapcraft tour` command snapcraft (launchpad) closed `snapcraft tour` was re-enabled by PR #559 (commit cadeb87ea, "Reenable tour command"), merged by Didier Roche and released in snapcraft 2.11 to xenial -updates; SRU verification passed and LP bug janitored.
80%
#1674952 snapcraft tour broken when installed from snap snapcraft (launchpad) closed Tour failed when snapcraft ran from a snap because it looked in /usr/share/snapcraft/tour. Fixed by merged PR snapcore/snapcraft#1217 (commit d365eb9ed, 'tour: make it work when its a snap'), linked in the closing comment.
73%
#559 Reenable tour command snapcraft merged Merged in #559 via cadeb87ea, restoring snapcraft tour with non-nesting directory logic plus unit and integration tests.
72%
#1590903 Improve snapcraft tour material snapcraft (launchpad) closed Tour content expansion shipped: upstream PR ubuntu-core/snapcraft#558 (commit 442b4f12) "Add finale tour examples and tests" fixed this; released in snapcraft 2.11 to xenial -proposed/-updates, verified by ~elopio and marked verification-done.
72%