← 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. 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.

Suggested action:

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
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 a one-line Makefile update adding docs-clean to the clean target. This resolves CI lint failures from stale documentation styles by ensuring make clean removes generated artifacts. Approved by two reviewers and passed all CI checks.
79%
#477 build(docs): make `clean` target scrub `docs/reference/gen` starbase merged Merged upstreamed changes to update the build clean target, ensuring it removes the generated docs/reference/gen directory. Approved by two reviewers and passed all CI checks.
77%
#1423 build(docs): make `clean` target scrub `reference/gen` craft-parts merged Merged. Updated the build clean target to explicitly scrub docs/reference/gen instead of relying on implicit Git ignores. Approved by three reviewers and passed CI checks, including all test suites and linting.
75%
#6133 build: fix docs-install target snapcraft merged Merged a fix for the docs-install Makefile target that resolved redundant dependency installation. The change removes an extra uv sync call, ensuring docs targets work after make setup. Approved by reviewers and passed CI.
75%
#563 fix(build): collapse docs-install logs under parent targets starbase merged Merged a Makefile update that collapses docs-install log output under parent targets to prevent CI log clutter. Approved by reviewers, passed all CI checks, and resolves the logging issue.
73%
#525 build: fix docs-install target starbase merged Merged a build fix optimizing the docs-install target by retaining dev dependencies throughout make lint execution. Approved by reviewers and passed CI checks, yielding a faster and more correct linting process.
70%