Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates repository review guidance to avoid suggesting Bash syntax checks (bash -n) on GitHub Actions workflow YAML files, and to instead reserve Bash/shell linting for actual shell scripts or extracted shell snippets.
Changes:
- Remove/avoid guidance that implies
bash -nshould be used on.github/workflows/*.ymlworkflow files. - Add explicit notes clarifying that workflows are YAML (use YAML parsing checks instead), while
bash -n/shellcheckshould target.shcontent. - Preserve existing “guarded PyYAML parse” guidance for local workflow validation.
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 to avoid recommending bash -n for workflow YAML and to scope shell validation appropriately. |
| .github/CONTRIBUTING.md | Updates contributor guidance to clarify correct local validation approaches for workflow YAML vs shell scripts. |
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
bash -nagainst GitHub Actions workflow files because workflows are YAML, not shell scripts..ymlfiles.Description
.github/CONTRIBUTING.mdto remove the suggestion to runbash -non workflow YAML and add a note that Bash syntax checks are not applicable to.github/workflows/*.ymlfiles..github/instructions/workflows.instructions.mdto advise reviewers not to recommendbash -nfor workflow YAML and to limitbash -norshellcheckto actual.shfiles or extracted shell snippets.python3 -c 'import yaml'check).Testing
git diff -- .github/CONTRIBUTING.md .github/instructions/workflows.instructions.mdto verify the intended edits were present, and the diff showed the expected changes (success).rg -n --hidden --no-ignore "bash -n .*release\.yml|Do not recommend \bash -n`|Bash syntax checks such as `bash -n` are not applicable|shellcheck.sh|Python YAML parse example" .github -S` to confirm the old recommendation was removed and new notes added (success).git status --shortto ensure only the intended files were modified (success).Codex Task