Skip to content

Tighten workflow recompile guardrails for .github/workflows/*.md edits#47962

Merged
pelikhan merged 2 commits into
mainfrom
copilot/hippo-improve-workflow-guardrails
Jul 25, 2026
Merged

Tighten workflow recompile guardrails for .github/workflows/*.md edits#47962
pelikhan merged 2 commits into
mainfrom
copilot/hippo-improve-workflow-guardrails

Conversation

Copilot AI commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

Stale .lock.yml files remain a common source of avoidable CI failures after workflow markdown edits. This change makes the recompile expectation explicit in both enforcement paths and contributor guidance so drift is easier to catch and fix immediately.

  • Guardrail messaging

    • Updated the stale-lock and workflow-drift scripts to explicitly call out the repository-specific rule:
      • if .github/workflows/*.md changes, run make recompile before committing
    • Kept the remediation centered on the canonical repository command rather than generic compile advice
  • Focused drift-check coverage

    • Extended shell-script tests to assert the new reminder appears in:
      • stale lock-file failures
      • workflow drift failures
      • compile-failure paths inside drift validation
  • Contributor guidance

    • Added a prominent reminder to the workflow editing guide that github/gh-aw contributors should treat any workflow markdown edit as a cue to run make recompile
    • Documented gh aw compile --watch --schedule-seed github/gh-aw as an early-feedback loop while keeping make recompile as the final commit-time step
    • Updated contributor-facing recompile instructions and issue helper copy to prefer the repository wrapper when available

Example of the updated remediation path:

make recompile
git add .github/workflows/*.lock.yml

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Improve guardrails for workflow authoring validation Tighten workflow recompile guardrails for .github/workflows/*.md edits Jul 25, 2026
Copilot AI requested a review from pelikhan July 25, 2026 09:07
@github-actions

Copy link
Copy Markdown
Contributor

Hey @Copilot 👋 — this PR looks great! You've tightened the workflow recompile guardrails with clear, actionable messaging.

What stands out:

  • Guardrail messaging: Shell scripts now explicitly tell contributors to run make recompile after .github/workflows/*.md edits, addressing a recurring source of CI failures.
  • Comprehensive test coverage: Extended tests in both check-stale-lock-files_test.sh and check-workflow-drift_test.sh verify the new reminder appears in all failure paths, including compilation failures.
  • Contributor guidance: The workflow editing guide now includes a prominent tip explaining the make recompile requirement and early-feedback loop with gh aw compile --watch.
  • Single focused change: All changes center on improving visibility of the recompile expectation without mixing unrelated work.

The diff is tight, tests are present, and the issue (#47744) is properly linked. This is ready for review.

Generated by ✅ Contribution Check · sonnet46 · 63.8 AIC · ⌖ 12.3 AIC · ⊞ 6.2K ·

@pelikhan
pelikhan marked this pull request as ready for review July 25, 2026 09:46
Copilot AI review requested due to automatic review settings July 25, 2026 09:46
@pelikhan
pelikhan merged commit 9d59c7c into main Jul 25, 2026
@pelikhan
pelikhan deleted the copilot/hippo-improve-workflow-guardrails branch July 25, 2026 09:46

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Clarifies repository-specific workflow recompilation requirements to prevent stale lock-file CI failures.

Changes:

  • Adds actionable make recompile guidance to drift checks.
  • Extends shell tests for remediation messaging.
  • Updates contributor and workflow-editing documentation.
Show a summary per file
File Description
scripts/check-workflow-drift.sh Improves compile and drift failure guidance.
scripts/check-workflow-drift_test.sh Tests the updated reminders.
scripts/check-stale-lock-files.sh Adds explicit recompilation remediation.
scripts/check-stale-lock-files_test.sh Verifies stale-lock guidance.
docs/src/content/docs/guides/editing-workflows.md Documents repository-specific editing workflow.
CONTRIBUTING.md Clarifies the commit-time requirement.
actions/setup/md/workflow_recompile_issue.md Prefers repository compilation wrappers.

Review details

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 7/7 changed files
  • Comments generated: 0
  • Review effort level: Medium

@github-actions

Copy link
Copy Markdown
Contributor

🎉 This pull request is included in a new release.

Release: v0.83.3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[hippo] Improve workflow authoring guardrails around missing make recompile after markdown edits

3 participants