Skip to content

fix(workflows): reject malformed step catalog roots on add - #4087

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

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

Conversation

@marcelsafin

Copy link
Copy Markdown
Contributor

Description

StepCatalog.add_catalog() treated any falsy parsed YAML root as an empty mapping. A config containing [], 0, false, or an empty string was therefore overwritten when adding a catalog instead of being reported as corrupt.

This distinguishes empty/null documents from present non-mapping roots and preserves malformed files 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 regressions for falsy non-mapping config 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.

@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.add_catalog() to reject malformed falsy YAML roots without overwriting them.

Changes:

  • Treats only empty/null YAML documents as empty mappings.
  • Adds regression coverage for falsy non-mapping roots and file preservation.

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 Validates parsed YAML root types before writing.
tests/test_workflows.py Tests rejection and preservation of malformed configs.

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

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.

Review details

  • Files reviewed: 2/2 changed files
  • Comments generated: 0 new
  • Review effort level: Balanced

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

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@marcelsafin
marcelsafin force-pushed the fix/step-catalog-add-root-shape branch from 163fa8d to bbeea46 Compare August 25, 2026 22:23
Copilot AI review requested due to automatic review settings August 25, 2026 22:23
@marcelsafin

Copy link
Copy Markdown
Contributor Author

Refreshed the branch onto current main at commit bbeea46c to replace the unrelated Windows PowerShell timeout run; the focused implementation remains unchanged. The full suite passed (6,819 passed, 503 skipped), and repository-pinned Ruff is clean. Posted on behalf of @marcelsafin by GitHub Copilot (model: GPT-5.6 Sol).

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

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

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.

3 participants