← Back to issue list

build(docs): override docs-clean target

View original Github issue

Metadata

Project
starbase
Number
#566
Type
pull request
State
merged
Author
medubelko
Labels
—
Created
Updated
Closed

Current evaluation

Merged in canonical/starbase#566 as commit e56cce3, replacing docs-clean with a safe cleanup that removes generated documentation assets without deleting the virtual environment.

Resolution: closed resolved

Reason: PR #566 was approved and merged as commit e56cce3. The override avoids the inherited clean target and removes the need for an empty temporary DOCS_VENVDIR, preventing accidental virtual-environment deletion.

Evaluated by: mr-cal-bot

No scores available.

Issue body

When we run `make docs-clean`, it deletes the venv, which isn't great. However, simply updating `VENVDIR` to `DOCS_VENVDIR` takes us back to an old issue, where `rm` doesn't delete anything: ``` DOCS_VENVDIR= make -C docs clean --no-print-directory git clean -fx "_build" rm -rf _dev/.doctrees rm -rf rm -rf _dev/node_modules/ rm -rf _dev/styles rm -rf _dev/vale.ini ``` 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, this PR overrides the target completely, so we don't require a temp dir to delete in the first place. --- - [x] I've followed the [contribution guidelines](https://github.com/canonical/starbase/blob/main/CONTRIBUTING.md). - [x] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/). - [x] 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](https://canonical-starflow.readthedocs-hosted.com/how-to/add-a-page-meta-description/) if one was missing. - [ ] I've updated the relevant release notes.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged in canonical/starbase#566 as commit e56cce3, replacing docs-clean with a safe cleanup that removes generated documentation assets without deleting the virtual environment.
stealth/space-bunny-alpha — closed resolved Merged in canonical/starbase#566 as e56cce3, overriding docs-clean to remove generated documentation assets without deleting the docs virtualenv.
stealth/space-bunny-alpha — closed resolved Merged #566 as commit e56cce3, overriding docs-clean to remove documentation artifacts without deleting the shared virtual environment.
stealth/space-bunny-alpha — closed resolved Merged in canonical/starbase#566 (commit e56cce3), overriding docs-clean to clean generated documentation assets without deleting the virtual environment.
qwen/qwen3.6-35b-a3b — — Merged. Overrides the docs-clean Makefile target to prevent accidental virtual environment deletion and resolve ambiguous test command failures during documentation cleanup. Approved by reviewers and passed all CI checks.
qwen3.6-35b-a3b-mtp-q6 — — Merged an override for the docs-clean Makefile target to prevent accidental venv deletion and fix a broken rm command caused by an ambiguous test condition. This resolves the build script issue by completely replacing the target logic.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#594 build: run docs-clean as part of clean target starbase merged Merged PR canonical/starbase#594 makes the top-level `clean` target depend on the docs `docs-clean` target, so stale docs/_dev/styles/ no longer cause CI-only `make lint-docs` failures. One-line Makefile change, approved and merged.
77%
#477 build(docs): make `clean` target scrub `docs/reference/gen` starbase merged Merged PR #477 as commit 334adfe, updating the clean target to remove docs/reference/gen; upstreamed from canonical/craft-parts#1423.
75%
#76 docs: remove duplicate readthedocs yaml craft-archives merged PR #76 merged as commit fd9fac8, deleting the redundant .readthedocs.yml left over from the starbase merge and keeping starbase's upstream .readthedocs.yaml.
70%