Skip to content

Clarify workflow YAML tooling warning#789

Merged
mfoltz merged 1 commit intomainfrom
codex/update-review/testing-warning-message-2026-03-21t22-07-29z
Mar 21, 2026
Merged

Clarify workflow YAML tooling warning#789
mfoltz merged 1 commit intomainfrom
codex/update-review/testing-warning-message-2026-03-21t22-07-29z

Conversation

@mfoltz
Copy link
Copy Markdown
Owner

@mfoltz mfoltz commented Mar 21, 2026

Motivation

  • Make the contributor-facing review/testing note accurately describe the local failure mode observed when validating .github/workflows/release.yml, and avoid wording that implies Python itself is unavailable or broken.

Description

  • Add a ## Review/testing note to .github/CONTRIBUTING.md that preserves the python3 check, documents the exact failure ModuleNotFoundError: No module named 'yaml', and clarifies this is a missing PyYAML/tooling dependency rather than evidence that .github/workflows/release.yml is invalid YAML.

Testing

  • Verified the updated note and file content with sed -n '1,120p' .github/CONTRIBUTING.md and reproduced the failure using python3 - <<'PY'\nimport yaml\nPY which fails with ModuleNotFoundError: No module named 'yaml', matching the documented behavior.

Codex Task

Copilot AI review requested due to automatic review settings March 21, 2026 22:07
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates contributor documentation to clarify that a common local “YAML validation” warning for .github/workflows/release.yml can stem from missing Python tooling (PyYAML), not from invalid workflow YAML.

Changes:

  • Add a “Review/testing note” to .github/CONTRIBUTING.md.
  • Document the exact local failure mode: ModuleNotFoundError: No module named 'yaml' from import yaml.
  • Clarify this is an environment/tooling dependency issue (missing PyYAML), not proof the workflow file is invalid.

@mfoltz mfoltz merged commit bafee09 into main Mar 21, 2026
10 checks passed
@mfoltz mfoltz deleted the codex/update-review/testing-warning-message-2026-03-21t22-07-29z branch March 21, 2026 22:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants