From efe8f6a00ed6787f3c30977cb39807bddc1f2769 Mon Sep 17 00:00:00 2001 From: Alex Lowe Date: Wed, 1 Oct 2025 12:26:01 -0400 Subject: [PATCH 1/4] docs: add a preview page for reusing packages Adds a preview page for how to reuse packages between builds. Also prepares for the 5.11.0 release. Signed-off-by: Alex Lowe --- docs/conf.py | 6 ++---- docs/how-to-guides/index.rst | 1 + .../reuse-packages-between-builds.rst | 16 ++++++++++++++++ docs/reference/changelog.rst | 4 ++-- 4 files changed, 21 insertions(+), 6 deletions(-) create mode 100644 docs/how-to-guides/reuse-packages-between-builds.rst diff --git a/docs/conf.py b/docs/conf.py index e5357c08f..f5b51b52c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -47,10 +47,8 @@ "base", "sphinx-resources", "common/README.md", - "common/craft-application/how-to-guides/build-remotely.rst", - "common/craft-application/how-to-guides/reuse-packages-between-builds.rst", - "common/craft-application/reference/remote-builds.rst", - "common/craft-application/reference/fetch-service.rst", + # Exclude all of our common docs as they'll be included explicitly. + "common/craft-application/**", # There's no tutorials right now, so just hide the scaffolding "tutorials", ] diff --git a/docs/how-to-guides/index.rst b/docs/how-to-guides/index.rst index be9e5e68d..302e9f8f8 100644 --- a/docs/how-to-guides/index.rst +++ b/docs/how-to-guides/index.rst @@ -9,3 +9,4 @@ How-to guides build-remotely partitions platforms + reuse-packages-between-builds diff --git a/docs/how-to-guides/reuse-packages-between-builds.rst b/docs/how-to-guides/reuse-packages-between-builds.rst new file mode 100644 index 000000000..a5eb79a4b --- /dev/null +++ b/docs/how-to-guides/reuse-packages-between-builds.rst @@ -0,0 +1,16 @@ +.. tip:: + + This is a preview of the reusable *Reuse packages between builds* documentation. + It can be included in your documentation by inserting a file that looks as follows, + with the appropriate changes + + .. literalinclude:: reuse-packages-between-builds.rst + :start-after: .. :docs-include: +.. |an-artifact| replace:: an artifact +.. |app| replace:: +.. |app-command| replace:: +.. |artifact| replace:: artifact +.. |star| replace:: package +.. |Starcraft| replace:: Craft Application + +.. include:: /common/craft-application/how-to-guides/reuse-packages-between-builds.rst diff --git a/docs/reference/changelog.rst b/docs/reference/changelog.rst index 780052bc3..17d92c01a 100644 --- a/docs/reference/changelog.rst +++ b/docs/reference/changelog.rst @@ -4,13 +4,13 @@ Changelog ********* -5.11.0 (2025-09-XX) +5.11.0 (2025-10-01) ------------------- Documentation ============= -- Add common page *Reuse packages between builds* for use in apps' documentation. +- Add common page :doc:`/how-to-guides/reuse-packages-between-builds` for use in apps' documentation. 5.10.3 (2025-09-22) ------------------- From e26ded62e2baf827f6c3539235c6c77299960ee2 Mon Sep 17 00:00:00 2001 From: Alex Lowe Date: Wed, 1 Oct 2025 12:36:56 -0400 Subject: [PATCH 2/4] fix: put the tip after the title --- docs/how-to-guides/reuse-packages-between-builds.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/how-to-guides/reuse-packages-between-builds.rst b/docs/how-to-guides/reuse-packages-between-builds.rst index a5eb79a4b..50f4186e9 100644 --- a/docs/how-to-guides/reuse-packages-between-builds.rst +++ b/docs/how-to-guides/reuse-packages-between-builds.rst @@ -1,3 +1,6 @@ +Reuse packages between builds +============================= + .. tip:: This is a preview of the reusable *Reuse packages between builds* documentation. @@ -5,6 +8,7 @@ with the appropriate changes .. literalinclude:: reuse-packages-between-builds.rst + :end-before: :start-after: ===== :start-after: .. :docs-include: .. |an-artifact| replace:: an artifact .. |app| replace:: @@ -14,3 +18,4 @@ .. |Starcraft| replace:: Craft Application .. include:: /common/craft-application/how-to-guides/reuse-packages-between-builds.rst + :start-after: ===== From 20e2ab3dc1d190d07d781d0932d98269425f3e9f Mon Sep 17 00:00:00 2001 From: Alex Lowe Date: Wed, 1 Oct 2025 12:39:24 -0400 Subject: [PATCH 3/4] fix: remove unused replacements --- docs/how-to-guides/reuse-packages-between-builds.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/how-to-guides/reuse-packages-between-builds.rst b/docs/how-to-guides/reuse-packages-between-builds.rst index 50f4186e9..d48869833 100644 --- a/docs/how-to-guides/reuse-packages-between-builds.rst +++ b/docs/how-to-guides/reuse-packages-between-builds.rst @@ -14,8 +14,6 @@ Reuse packages between builds .. |app| replace:: .. |app-command| replace:: .. |artifact| replace:: artifact -.. |star| replace:: package -.. |Starcraft| replace:: Craft Application .. include:: /common/craft-application/how-to-guides/reuse-packages-between-builds.rst :start-after: ===== From 05bbfd67d14352eca08dbb8aceb4b814f16885fa Mon Sep 17 00:00:00 2001 From: Alex Lowe Date: Wed, 1 Oct 2025 12:41:52 -0400 Subject: [PATCH 4/4] fix: add commit link --- docs/reference/changelog.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/reference/changelog.rst b/docs/reference/changelog.rst index 17d92c01a..bc1574f64 100644 --- a/docs/reference/changelog.rst +++ b/docs/reference/changelog.rst @@ -12,6 +12,8 @@ Documentation - Add common page :doc:`/how-to-guides/reuse-packages-between-builds` for use in apps' documentation. +For a complete list of commits, check out the `5.11.0`_ release on GitHub. + 5.10.3 (2025-09-22) ------------------- @@ -1062,3 +1064,4 @@ For a complete list of commits, check out the `2.7.0`_ release on GitHub. .. _5.9.1: https://github.com/canonical/craft-application/releases/tag/5.9.1 .. _5.10.0: https://github.com/canonical/craft-application/releases/tag/5.10.0 .. _5.10.1: https://github.com/canonical/craft-application/releases/tag/5.10.1 +.. _5.11.0: https://github.com/canonical/craft-application/releases/tag/5.11.0