docs: add a "pack a Pro snap" how-to by mr-cal · Pull Request #6367 · canonical/snapcraft

mr-cal · 2026-07-22T16:28:38Z

Adds a Pack a Pro snap how-to document.

Blocked by canonical/craft-application#1144
(CRAFT-5236)

I've followed the contribution guidelines.
I've signed the CLA.
I've successfully run make lint && make test.
I've added or updated any relevant documentation.
In documents I changed, I added a meta description if one was missing.
I've updated the relevant release notes.

mr-cal · 2026-07-22T16:29:14Z

    "catkin-pkg==1.1.0; sys_platform == 'linux'",
    "click>=8.3.3",
-    "craft-application[remote]>=7.1.0",
+    "craft-application[remote] @ git+https://github.com/canonical/craft-application@work/CRAFT-5237/pro-docs",


Reminder to bump before landing

Copilot

Pull request overview

Adds a new Snapcraft how-to page for packing Ubuntu Pro–compliant snaps by composing (and partially overriding) shared Craft Application documentation, and wires it into the Crafting docs navigation. The PR also temporarily switches craft-application to a git dependency to pick up the required shared-doc content.

Changes:

Add pack-a-pro-snap how-to (Core24+ via shared docs include; Core22 legacy guidance inline).
Link the new how-to from docs/how-to/crafting/index.rst.
Point craft-application dependency (and lockfile) at a git ref to obtain the needed shared docs.

Reviewed changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 6 comments.

File	Description
uv.lock	Switches `craft-application` resolution from PyPI to a git source to pick up upstream docs content.
pyproject.toml	Updates runtime dependency on `craft-application` to a git ref for the same reason.
docs/how-to/crafting/pack-a-pro-snap.rst	New how-to page combining shared Craft Application docs with Snapcraft-specific Core22 legacy instructions.
docs/how-to/crafting/index.rst	Adds the new how-to to the Crafting section list and hidden toctree.

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

medubelko

This one got a little away from me. Apologies for the extra review.

medubelko · 2026-07-22T22:04:11Z

    specify-a-base
    select-platforms
    manage-dependencies
+    pack-a-pro-snap


Let's move this to the end of the list. The homepage progress has made the existing TOC taste bad to me.

medubelko · 2026-07-22T22:06:56Z

+.. include:: ../../common/craft-application/how-to-guides/pack-a-pro-artifact.rst
+    :end-before: .. Split point for downstream docs: Prerequisites onward


There's an inconsistency here. The title is transcluded, but the first heading isn't. If this is override is needed, then I don't think it's worth transcluding the title – may as well write it here, and transclude the two sections, without headings.

ffb2c98

Nice catch, I simplified it to "begin overview" and "end overview". Hopefully that makes it easier to read the rst and is properly transcluded.

medubelko · 2026-07-22T22:07:27Z

+.. include:: ../../common/craft-application/how-to-guides/pack-a-pro-artifact.rst
+    :end-before: .. Split point for downstream docs: Prerequisites onward


onward

And upward?

medubelko · 2026-07-22T22:09:06Z

+Core22 snaps use a legacy mechanism to pack Pro-compliant snaps. As a result, it uses
+the previous name UA (Ubuntu Advantage) instead of Ubuntu Pro.


Forgive the nitpick that I didn't raise earlier:

Suggested change

Core22 snaps use a legacy mechanism to pack Pro-compliant snaps. As a result, it uses

the previous name UA (Ubuntu Advantage) instead of Ubuntu Pro.

Core22 snaps use a legacy mechanism to pack Pro-compliant snaps. The mechanism uses the

term *Ubuntu Advantage* (UA) instead of *Ubuntu Pro*.

medubelko · 2026-07-22T22:10:24Z

+services. The Ubuntu Pro Client documentation has `further information
+<https://documentation.ubuntu.com/pro-client/en/v32/explanations/which_services/>`__ on
+each service.


Suggested change

services. The Ubuntu Pro Client documentation has `further information

<https://documentation.ubuntu.com/pro-client/en/v32/explanations/which_services/>`__ on

each service.

services. The Ubuntu Pro Client documentation has `detailed information on each service

<https://documentation.ubuntu.com/pro-client/en/v32/explanations/which_services/>`__.

Alternatively, we could link this in the side bar with seealso.

Interesting, I hadn't seen seealso before. Like the seealsos on this page? I don't see anything in the sidebar on that page for the links.

ffb2c98 (I went with the first suggestion in the interim)

medubelko · 2026-07-22T22:11:20Z

+<https://documentation.ubuntu.com/pro-client/en/v32/explanations/which_services/>`__ on
+each service.
+
+To enable the desired Pro services when building your snap, add a ua-services key to


Suggested change

To enable the desired Pro services when building your snap, add a ua-services key to

Add a ``ua-services`` key to your snap, and list the services:

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

Copilot AI review requested due to automatic review settings July 22, 2026 16:28

mr-cal changed the title ~~docs" add~~ docs: add a "pack a Pro snap" how-to Jul 22, 2026

Copilot started reviewing on behalf of mr-cal July 22, 2026 16:29 View session

mr-cal commented Jul 22, 2026

View reviewed changes

Copilot AI reviewed Jul 22, 2026

View reviewed changes

mr-cal force-pushed the work/CRAFT-5236/pro-docs branch from 925e265 to df59147 Compare July 22, 2026 17:56

mr-cal added 2 commits July 22, 2026 14:07

build(deps): point craft-application to dev branch

495834e

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

docs: add a "pack a Pro snap" how-to

8772b47

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

mr-cal force-pushed the work/CRAFT-5236/pro-docs branch from df59147 to 8772b47 Compare July 22, 2026 19:07

mr-cal mentioned this pull request Jul 22, 2026

docs: add a "pack a Pro artifact" how-to canonical/craft-application#1144

Open

4 tasks

mr-cal marked this pull request as ready for review July 22, 2026 21:06

mr-cal requested a review from a team as a code owner July 22, 2026 21:06

mr-cal requested review from medubelko and steinbro and removed request for a team July 22, 2026 21:06

medubelko reviewed Jul 22, 2026

View reviewed changes

mr-cal added 2 commits July 23, 2026 12:03

docs: feedback from PR

ffb2c98

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

build(deps): point craft-application to dev branch

6f6f355

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

mr-cal requested a review from medubelko July 23, 2026 17:23

steinbro approved these changes Jul 24, 2026

View reviewed changes

		.. include:: ../../common/craft-application/how-to-guides/pack-a-pro-artifact.rst
		:end-before: .. Split point for downstream docs: Prerequisites onward

		Core22 snaps use a legacy mechanism to pack Pro-compliant snaps. As a result, it uses
		the previous name UA (Ubuntu Advantage) instead of Ubuntu Pro.

	To enable the desired Pro services when building your snap, add a ua-services key to
	Add a ``ua-services`` key to your snap, and list the services:

Uh oh!

Conversation

mr-cal commented Jul 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

medubelko left a comment

Choose a reason for hiding this comment

Uh oh!

medubelko Jul 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mr-cal Jul 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mr-cal commented Jul 22, 2026 •

edited

Loading

medubelko Jul 22, 2026 •

edited

Loading

mr-cal Jul 23, 2026 •

edited

Loading