Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR clarifies reviewer/contributor guidance for locally validating GitHub Actions workflow YAML by emphasizing use of the repo-managed environment/tooling and by providing a guarded Python YAML-parse example that distinguishes missing dependencies from actual YAML/workflow defects.
Changes:
- Updates workflow review instructions to recommend running
bash .codex/install.shbefore local YAML parsing checks and to explicitly note the PyYAML dependency. - Updates contributing guidance with the same dependency caveat and adds a guarded
import yamlcheck before attemptingyaml.safe_load.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| .github/instructions/workflows.instructions.md | Adds reviewer guidance about running repo tooling first and treating missing YAML parser deps as a local issue. |
| .github/CONTRIBUTING.md | Adds contributor-facing guidance plus a guarded Python YAML-parse example for .github/workflows/release.yml. |
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
Description
.github/CONTRIBUTING.mdto instruct contributors to runbash .codex/install.shin the repo-managed environment before performing YAML parsing checks and to note that the inlineimport yamlexample depends on PyYAML.python3 -c 'import yaml'and either warns about the missing PyYAML dependency or runs ayaml.safe_loadparse of.github/workflows/release.yml..github/instructions/workflows.instructions.mdwith the same guidance for reviewers and an explicit statement that a missing YAML parser dependency is a local tooling issue, not a GitHub Actions workflow syntax defect.Testing
bash .codex/install.sh, which provisioned the .NET SDK, installed PyYAML andshellcheck, and built the project successfully.bash .codex/shellcheck.shto lint shell scripts and it completed without errors.python3 -c 'import yaml'guard +yaml.safe_loadon.github/workflows/release.yml) and the workflow file parsed successfully.Codex Task