chore(merge): update starbase (2026-07-22) by lengau · Pull Request #177 · canonical/debcraft

lengau · 2026-07-22T17:14:46Z

Merge starbase/main into this branch and sync Starbase-managed updates.

Overview of Starbase changes pulled in

Refreshed shared CI and linting workflow baselines.
Adopted the current docs scaffold layout (docs/_dev, templates, and Sphinx config updates).
Synced shared build and tooling configuration files.
Added repository-level OSV scanner configuration.

Conflict resolution applied

Kept child-repo version of .github/workflows/qa.yaml.
Kept child-repo version of uv.lock and updated it for merged dependency metadata.
Kept .github/README.md deleted for this repository.
Replaced Starcraft placeholders with Debcraft-specific values where required.

Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com> Co-authored-by: Tiago Nobrega <tiago.nobrega@canonical.com>

…5.12 (#527) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Apply better patterns: - Move `docs/how-to-guides` to `docs/how-to`. - Add meta-project TOC. - Fix indentation in some boilerplate. - Add default descriptions to landing pages. - Fix some ruff linting problems in `conf.py`.

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

…5.13 (#535) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

…5.14 (#536) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* build(docs): update Sphinx Stack to 2.0 * docs: fix autobuild loop * chore: lock deps * docs: revise metadata for homepage and main indexes --------- Signed-off-by: JJ Coldiron <jj.coldiron@canonical.com> Co-authored-by: Michael DuBelko <michael.dubelko@canonical.com>

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

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

Fixes starbase#538 --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>

The instructions were incorrect and out of date.

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Signed-off-by: Alex M. Lowe <alex.lowe@canonical.com>

Co-authored-by: Alex Lowe <alex.lowe@canonical.com>

--------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>

Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com> Co-authored-by: Tiago Nobrega <tiago.nobrega@canonical.com>

The `docs-clean` target in the docs Makefile has an ambiguous `test` command that fails if we export a temp directory to it. To work around that, override the target completely, so we don't require a temp dir to delete in the first place.

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

…5.20 (main) (#571)

…5.21 (main) (#575)

Updates the python-scans job in policy.yaml to use the newest configuration options of starflow's security scanner, including an osv-scanner.toml configuration placeholder and adding exclude paths. --------- Signed-off-by: Alex Lowe <alex.lowe@canonical.com>

Signed-off-by: Alex M. Lowe <alex.lowe@canonical.com>

Implement shell formatting tool (shfmt) as requested in #531. --------- Signed-off-by: Alex Lowe <alex.lowe@canonical.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>

Copilot

Pull request overview

This PR merges Starbase-managed baseline updates into Debcraft, refreshing shared tooling/CI configuration and migrating the documentation scaffold to the current Sphinx Stack layout.

Changes:

Updated Python/tooling configuration (uv groups/constraints, pre-commit hooks, shfmt integration).
Migrated docs scaffolding to Sphinx Stack (docs/_dev, updated Sphinx config, templates, and requirements).
Refreshed CI/security scanning workflows (permissions, OSV scanner config, Renovate checks).

Reviewed changes

Copilot reviewed 33 out of 37 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
pyproject.toml	Updates project metadata and dependency groups (docs/types/dev) and uv constraints.
osv-scanner.toml	Adds OSV scanner config file used by workflow.
Makefile	Adds shfmt to formatting pipeline.
docs/tutorials/index.rst	Adds meta description and updates tutorials landing copy.
docs/requirements.txt	Syncs Sphinx Stack dependency set/pins for docs builds.
docs/release-notes/index.rst	Adds meta description and adjusts toctree settings.
docs/reference/index.rst	Adds meta description and updates reference landing copy.
docs/README.md	Updates docs subproject instructions from starter pack to Sphinx Stack.
docs/Makefile	Migrates docs build tooling paths from `.sphinx` to `_dev`, adjusts lint targets.
docs/index.rst	Updates site navigation/toctree structure for new docs layout.
docs/how-to/index.rst	Adds new how-to landing page to replace removed how-to-guides index.
docs/how-to-guides/index.rst	Removes legacy how-to-guides index page.
docs/explanation/index.rst	Adds meta description and updates explanation landing copy/toctree.
docs/explanation/documentation.rst	Updates external link target to Sphinx Stack reference docs.
docs/conf.py	Updates Sphinx configuration to Sphinx Stack conventions and extensions.
docs/.sphinx/version	Removes old starter pack version marker.
docs/.gitignore	Updates ignored paths for `_dev` and `.venv` layout.
docs/.custom_wordlist.txt	Adds “Starbase” to custom word list.
docs/_templates/header.html	Adds custom header template (navigation/GTM hooks).
docs/_templates/footer.html	Adds custom footer template (license, contributors, cookie controls).
docs/_static/js/bundle.js	Removes previously committed bundled JS artifact.
docs/_static/css/cookie-banner.css	Removes old cookie banner CSS artifact.
docs/_dev/version	Adds Sphinx Stack `_dev` version marker.
docs/_dev/update_sp.py	Migrates update script from starter pack to Sphinx Stack upstream.
docs/_dev/pa11y.json	Adds pa11y configuration for accessibility checks.
docs/_dev/get_vale_conf.py	Updates Vale config fetcher paths to `_dev`.
docs/_dev/.pymarkdown.json	Adds pymarkdown configuration for docs linting.
docs/_dev/.pre-commit-config.yaml	Adds docs-specific pre-commit hooks (spelling/linkcheck/woke).
CONTRIBUTING.md	Removes bounty-related contribution text.
common.mk	Updates shared make targets (help output, shfmt targets, docs targets).
AGENTS.md	Adds repository agent/development guidance document.
.prettierignore	Excludes `docs/_dev` from prettier.
.pre-commit-config.yaml	Updates ruff hook id and adds shfmt pre-commit hook.
.github/workflows/qa.yaml	Adds explicit workflow permissions.
.github/workflows/policy.yaml	Switches scan workflow inputs to OSV config + excludes docs groups/paths.
.github/workflows/check-renovate.yaml	Installs uv in Renovate validation workflow.

Comments suppressed due to low confidence (1)

docs/tutorials/index.rst:16

This page contains an empty toctree. Sphinx emits a warning for empty toctrees, and the docs Makefile builds with --fail-on-warning, so this can break make docs. Either add at least one child page here or remove the toctree until content exists.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Merge starbase/main into this branch and sync Starbase-managed updates. Overview of Starbase changes pulled in: - Refreshed shared CI, linting, and workflow baselines. - Migrated docs scaffold to the current Sphinx Stack layout under docs/_dev. - Synced shared build tooling and documentation templates. - Added repository-level OSV scanner configuration. Conflict resolution applied: - Kept child-repo QA workflow behavior and uv.lock ownership decisions. - Kept .github/README.md deleted for this repository type. - Preserved Debcraft-owned project metadata (including project license). - Applied child-specific docs identity and accessibility adjustments over the Starbase scaffold. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

medubelko

This is missing the changes to .readthedocs.yaml.

medubelko · 2026-07-22T18:06:19Z

 ogp_site_url = "https://canonical-debcraft.readthedocs-hosted.com/"

 # Preview name of the documentation website
+# TODO: To use a different name for the project in previews, update the next line.


Suggested change

# TODO: To use a different name for the project in previews, update the next line.

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

-    # 'product_tag': '_static/tag.png',
+    # "product_tag": "_static/tag.png",
+    # Your Discourse instance URL
+    # TODO: Change to your Discourse instance URL or leave empty.


Suggested change

# TODO: Change to your Discourse instance URL or leave empty.

medubelko · 2026-07-22T18:07:04Z

+    # TODO: Change to your Discourse instance URL or leave empty.
    "discourse": "",
    # Your Mattermost channel URL
+    # TODO: Change to your Mattermost channel URL or leave empty.


Suggested change

# TODO: Change to your Mattermost channel URL or leave empty.

medubelko · 2026-07-22T18:07:25Z

+author = "Canonical Ltd."
+
+# Format the product name and version for the TOC and HTML title
+# TODO: When the product begins versioning, uncomment this block.


Suggested change

# TODO: When the product begins versioning, uncomment this block.

The TODOs are for initial setup.

medubelko · 2026-07-22T18:07:40Z


 # Product favicon; shown in bookmarks, browser tabs, etc.
-# html_favicon = '.sphinx/_static/favicon.png'
+# TODO: To customise the favicon, uncomment and update the next line.


Suggested change

# TODO: To customise the favicon, uncomment and update the next line.

medubelko · 2026-07-22T18:08:30Z

+# TODO: If your documentation is hosted on https://documentation.ubuntu.com/,
+#       uncomment and set to the RTD slug.
+# slug = ""


Suggested change

# TODO: If your documentation is hosted on https://documentation.ubuntu.com/,

# uncomment and set to the RTD slug.

# slug = ""

medubelko · 2026-07-22T18:11:09Z

-# Copyright string; shown at the bottom of the page
-copyright = "2023-%s, %s" % (datetime.date.today().year, author)
+# The year in the copyright statement
+copyright = f"2023-{datetime.date.today().year}"


Did Debcraft start that far back?

medubelko · 2026-07-22T18:12:17Z

+# Add redirects to the 'redirects.txt' file
+# https://sphinxext-rediraffe.readthedocs.io/en/latest/
+
+# To set up redirects in the Read the Docs project dashboard:
+# https://docs.readthedocs.io/en/stable/guides/redirects.html
+


Suggested change

# Add redirects to the 'redirects.txt' file

# https://sphinxext-rediraffe.readthedocs.io/en/latest/

# To set up redirects in the Read the Docs project dashboard:

# https://docs.readthedocs.io/en/stable/guides/redirects.html

medubelko · 2026-07-22T18:13:50Z

-    'js/bundle.js',
-]
+# Adds custom JavaScript files, located remotely or in 'html_static_path'.
+# TODO: Uncomment to enable Google Analytics on public projects.


Suggested change

# TODO: Uncomment to enable Google Analytics on public projects.

medubelko · 2026-07-22T18:14:27Z

-    'css/cookie-banner.css'
-]
+# Adds custom CSS files, located remotely or in 'html_static_path'.
+# TODO: Uncomment to enable Google Analytics on public projects.


Suggested change

# TODO: Uncomment to enable Google Analytics on public projects.

mr-cal and others added 30 commits April 23, 2026 12:27

build: fix docs-install target (#525)

b434201

Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com> Co-authored-by: Tiago Nobrega <tiago.nobrega@canonical.com>

build(deps): update pre-commit hook astral-sh/ruff-pre-commit to v0.1…

5833fc6

…5.12 (#527) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

docs: minor clean up and reorg (#529)

50567fc

Apply better patterns: - Move `docs/how-to-guides` to `docs/how-to`. - Add meta-project TOC. - Fix indentation in some boilerplate. - Add default descriptions to landing pages. - Fix some ruff linting problems in `conf.py`.

build(deps): update softprops/action-gh-release action to v3 (#526)

c811509

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

docs: remove bounty instructions (#530)

f7ccae3

fix(ty): point to venv (#534)

cf39b36

build(deps): update pre-commit hook astral-sh/ruff-pre-commit to v0.1…

c7e200d

…5.13 (#535) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

build(deps): update pre-commit hook astral-sh/ruff-pre-commit to v0.1…

c9415c7

…5.14 (#536) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

build(deps): update dependency mypy to v2 (#533)

5641f05

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

build(deps): bump lxml (#540)

663c1b4

build(deps): update bugfixes to v0.15.15 (#539)

edcc1af

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

build(deps): add constraint for Starlette (#547)

ca8caba

docs: add filter to qa workflow (#546)

ccb17d2

docs: update starflow intersphinx mapping (#548)

7e56723

build(Makefile): add lint-code target (#549)

875e9e7

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

feat: add agents files (#543)

2cf6c9a

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

build: harden 'make help' for shell portability (#542)

3754b6a

Fixes starbase#538 --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>

fix: update path in '.prettierignore' (#550)

9491560

docs: resolve docs-lint issues (#551)

f44e2e7

docs(build): fix typos in make help output

f35148c

docs: fix AGENTS.md typo (#559)

b856f52

docs: update docs subproject readme (#554)

0b67b94

The instructions were incorrect and out of date.

build(deps): update ruff pre-commit to v0.15.17 (#561)

58d539b

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

chore: use the non-legacy ruff check pre-commit hook (#562)

ba42dd9

Signed-off-by: Alex M. Lowe <alex.lowe@canonical.com>

ci: set read permissions for qa workflow (#557)

cd8d487

Co-authored-by: Alex Lowe <alex.lowe@canonical.com>

fix(build): collapse docs-install logs under parent targets (#563)

544b986

--------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>

ci: add ubuntu-26.04 test platforms to QA workflow (#564)

12f1281

ci: add code owners (#567)

eeeb3db

Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com> Co-authored-by: Tiago Nobrega <tiago.nobrega@canonical.com>

build(docs): override docs-clean target (#566)

e56cce3

The `docs-clean` target in the docs Makefile has an ambiguous `test` command that fails if we export a temp directory to it. To work around that, override the target completely, so we don't require a temp dir to delete in the first place.

renovate Bot and others added 10 commits June 22, 2026 09:34

build(deps): update bugfixes to v0.15.18 (main) (#569)

d0c7328

build(deps): update github actions to v7 (main) (#568)

7c9407b

feat: codify CVE policy (#570)

d3f08a3

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

build(deps): update pre-commit hook astral-sh/ruff-pre-commit to v0.1…

63abe23

…5.20 (main) (#571)

build(deps): update dorny/paths-filter action to v4.0.2 (main) (#572)

ce67a6b

build(deps): update pre-commit hook astral-sh/ruff-pre-commit to v0.1…

95108a2

…5.21 (main) (#575)

build(deps): update dependency mypy to ~=2.2.0 (main) (#574)

9ee7880

ci: install uv in renovate check workflow (#576)

be54208

Signed-off-by: Alex M. Lowe <alex.lowe@canonical.com>

Copilot AI review requested due to automatic review settings July 22, 2026 17:14

lengau added the PR: Merge This PR should be a merge commit. label Jul 22, 2026

Copilot started reviewing on behalf of lengau July 22, 2026 17:15 View session

Copilot AI reviewed Jul 22, 2026

View reviewed changes

lengau force-pushed the work/update-starbase-2026-07-22 branch from 470c499 to 7a77fe9 Compare July 22, 2026 17:38

lengau marked this pull request as ready for review July 22, 2026 17:44

lengau requested review from a team and bepri as code owners July 22, 2026 17:44

medubelko requested changes Jul 22, 2026

View reviewed changes

	# TODO: If your documentation is hosted on https://documentation.ubuntu.com/,
	# uncomment and set to the RTD slug.
	# slug = ""

Uh oh!

Conversation

lengau commented Jul 22, 2026

Overview of Starbase changes pulled in

Conflict resolution applied

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!

Uh oh!

Uh oh!

Uh oh!

medubelko left a comment

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!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants