Skip to content

Simplify workflow review instructions#793

Merged
mfoltz merged 1 commit intomainfrom
codex/simplify-workflow-review-instructions-2026-03-22t11-49-56z
Mar 22, 2026
Merged

Simplify workflow review instructions#793
mfoltz merged 1 commit intomainfrom
codex/simplify-workflow-review-instructions-2026-03-22t11-49-56z

Conversation

@mfoltz
Copy link
Copy Markdown
Owner

@mfoltz mfoltz commented Mar 22, 2026

Motivation

  • Make the workflow-review guidance more concise and durable so reviewers focus on trigger correctness, brittle logic, and diagnosability rather than one-off remediation details.
  • Remove PyYAML-specific remediation notes and replace them with a short, general rule about YAML validation to reduce maintenance and false negatives in reviews.

Description

  • Update .github/instructions/workflows.instructions.md to keep core reviewer priorities (trigger correctness, path filters, checkout depth/history assumptions, merge-base logic, matrix behavior, and diagnosability) and the rule to avoid style-only comments.
  • Reword the bootstrap guidance to advise running bash .codex/install.sh before local workflow or tooling checks.
  • Remove the PyYAML example and replace it with a concise rule to Use an appropriate YAML-aware validator for workflow files and to treat missing local validator dependencies as an environment/tooling limitation rather than a workflow syntax failure.

Testing

  • No automated tests were run because this is a documentation-only change.

Codex Task

Copilot AI review requested due to automatic review settings March 22, 2026 11:50
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

This PR streamlines the repository’s workflow-review guidance to focus reviewers on durable correctness and diagnosability checks, while removing PyYAML-specific local validation instructions.

Changes:

  • Rewords local setup guidance to recommend running bash .codex/install.sh before performing local workflow/tooling checks.
  • Replaces PyYAML parsing examples with a general rule to use an appropriate YAML-aware validator for workflow files.
  • Clarifies that missing local YAML validation dependencies should be treated as an environment/tooling limitation, not a workflow syntax failure.

@mfoltz mfoltz merged commit 39c75a6 into main Mar 22, 2026
10 checks passed
@mfoltz mfoltz deleted the codex/simplify-workflow-review-instructions-2026-03-22t11-49-56z branch March 22, 2026 11:51
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