chore: low-risk technical debt pass#208
Closed
safl wants to merge 2 commits into
Closed
Conversation
Ruff F401 flagged 22 dead imports across docs/, src/, and tests/ that accumulated over time as code moved around. Cleared the same way ruff would auto-fix: no exports relied on any of them. While here, fixed an unused 'state' destructuring at cmdrunner.py:65 that pyright had been warning about, and dropped a 'not useful yet' commented rmdir at null_blk.py whose author note dates back several years; git history retains it if anyone wants it back. Signed-off-by: Simon A. F. Lund <os@safl.dk>
Three leftover spots after the workflow-to-task rename: the sphinx sidebar pattern at docs/source/conf.py still excluded 'workflows**' where the renamed directory is 'tasks/'; the example task header in example_task_default.yaml had a 'GitHUB' casing typo; and the bash completion's default filename was the legacy 'cijoe-workflow.yaml' so step-name completion silently failed for users on the new 'cijoe-task.yaml'. Prefer the new name and fall back to the legacy one so completion still works mid-migration. Signed-off-by: Simon A. F. Lund <os@safl.dk>
Collaborator
Author
|
Folded into #207 with the v0.9.60 version bump. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two scoped cleanup commits.
The first drops 22 unused imports flagged by ruff F401 across
docs/,src/, andtests/. None of them were API re-exports, confirmed by grepping for each name across the tree before applyingruff --fix. While in the same area, it also fixes an unusedstatedestructuring atsrc/cijoe/core/scripts/cmdrunner.py:65(a long-standing pyright warning) and removes a three-line commented-outrmdirinsrc/cijoe/linux/null_blk.pywhose author note had marked it "not useful yet".The second resolves three leftover references to "workflow" after the recent rename to "task". The Sphinx sidebar pattern in
docs/source/conf.pystill excludedworkflows**against a directory that has since becometasks/. The example task's header had a "GitHUB" casing typo. The bash completion atsrc/cijoe/core/auxiliary/cijoe-completionsonly knew the legacy default filenamecijoe-workflow.yaml, so step-name completion silently failed once a user moved tocijoe-task.yaml; it now prefers the new name and falls back to the legacy one for users mid-migration.Items the survey flagged but were intentionally left out:
src/cijoe/core/analyser.py(no in-tree callers but possibly external API), the open TODOs innull_blk.py,cli.py,testrunner.py, and the report template, thetomli/tomllibconditional inresources.py(3.10 has neither, so the conditional stays), and every deliberate back-compat shim from the rename.Test plan
Confirm
verify_and_publishis green on this branch and that no test depends on any of the removed imports.