Skip to content

fix(workflows): report malformed step roots on remove - #4095

Open
marcelsafin wants to merge 1 commit into
github:mainfrom
marcelsafin:fix/step-catalog-remove-root-shape
Open

fix(workflows): report malformed step roots on remove#4095
marcelsafin wants to merge 1 commit into
github:mainfrom
marcelsafin:fix/step-catalog-remove-root-shape

Conversation

@marcelsafin

Copy link
Copy Markdown
Contributor

Description

StepCatalog.remove_catalog() assumes the parsed YAML root is a mapping. Falsy non-mapping documents can therefore produce a misleading empty-catalog error instead of reporting the corrupt configuration.

This validates the document root before catalog lookup and preserves the malformed file unchanged.

Testing

  • Tested locally with uv run specify --help
  • Ran existing tests with uv sync && uv run pytest (6,655 passed, 177 skipped)
  • Added parameterized remove regressions for falsy non-mapping roots
  • uvx ruff@0.15.0 check src tests clean

AI Disclosure

  • I did not use AI assistance for this contribution
  • I did use AI assistance (describe below)

Implemented autonomously by GitHub Copilot CLI (model: GPT-5.6 Sol) under human direction; failing regressions were added before the fix, then the full suite and lint were run locally. Commit includes Assisted-by and Co-authored-by trailers.

Assisted-by: GitHub Copilot (model: gpt-5.6-sol, autonomous)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@marcelsafin
marcelsafin requested a review from mnriem as a code owner August 12, 2026 22:05
Copilot AI balanced review requested due to automatic review settings August 12, 2026 22:05

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Fixes StepCatalog.remove_catalog() to distinguish empty YAML documents from malformed non-mapping roots.

Changes:

  • Validates parsed YAML before catalog lookup.
  • Adds regressions for falsy non-mapping roots.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
src/specify_cli/workflows/catalog.py Rejects invalid YAML root types.
tests/test_workflows.py Tests falsy malformed roots.

馃挕 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants