Merged
Conversation
There was a problem hiding this comment.
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'fromimport yaml. - Clarify this is an environment/tooling dependency issue (missing PyYAML), not proof the workflow file is invalid.
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
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.
Motivation
.github/workflows/release.yml, and avoid wording that implies Python itself is unavailable or broken.Description
## Review/testing noteto.github/CONTRIBUTING.mdthat preserves thepython3check, documents the exact failureModuleNotFoundError: No module named 'yaml', and clarifies this is a missing PyYAML/tooling dependency rather than evidence that.github/workflows/release.ymlis invalid YAML.Testing
sed -n '1,120p' .github/CONTRIBUTING.mdand reproduced the failure usingpython3 - <<'PY'\nimport yaml\nPYwhich fails withModuleNotFoundError: No module named 'yaml', matching the documented behavior.Codex Task