Skip to content

Clarify lock files and trigger files are auto-generated; add do-not-modify headers#335

Merged
strawgate merged 2 commits intomainfrom
copilot/update-developing-guide-lock-files
Feb 21, 2026
Merged

Clarify lock files and trigger files are auto-generated; add do-not-modify headers#335
strawgate merged 2 commits intomainfrom
copilot/update-developing-guide-lock-files

Conversation

Copy link
Contributor

Copilot AI commented Feb 21, 2026

This PR clarifies that generated workflow artifacts in this repository are not meant to be edited directly and adds explicit guidance on how to regenerate them.

Changes

  • scripts/dogfood.sh

    • Prepends two comment lines to each generated .github/workflows/trigger-*.yml file.
    • The header states the file is generated, points to gh-agent-workflows/(name)/example.yml as the source, and tells contributors to run make compile.
  • gh-agent-workflows/DEVELOPING.md

    • Adds a direct warning not to edit .lock.yml files because they are compiled output overwritten by make compile.
    • Adds a direct warning not to edit trigger-*.yml files because they are generated by scripts/dogfood.sh and overwritten on compile.
    • Clarifies the compile workflow language so source files and generated artifacts are clearly distinguished.

Related context: #328

Fixes #334

Generated by Update PR Body

…generation in DEVELOPING.md

Co-authored-by: strawgate <6384545+strawgate@users.noreply.github.com>
Copilot AI changed the title [WIP] Update developing guide for modifying lock files and triggers Clarify lock files and trigger files are auto-generated; add do-not-modify headers Feb 21, 2026
Copilot AI requested a review from strawgate February 21, 2026 17:47
@strawgate strawgate marked this pull request as ready for review February 21, 2026 18:02
@coderabbitai
Copy link

coderabbitai bot commented Feb 21, 2026

📝 Walkthrough

Walkthrough

This PR adds auto-generated header comments to 25+ workflow files to indicate they are auto-generated and should not be edited directly. The development guide is updated to clarify that lock and trigger files are auto-generated, and the dogfood script is modified to emit these header comments when generating trigger files.

Changes

Cohort / File(s) Summary
Workflow Auto-Generated Headers
.github/workflows/trigger-*.yml (25 files)
Added two-line header comments to indicate files are auto-generated and how to regenerate. All changes are non-functional metadata additions.
Duplicate Issue Detector Workflow
.github/workflows/trigger-duplicate-issue-detector.yml
Added auto-generated header comments and introduced types: [opened] filter under on.issues configuration to restrict triggered events to opened issues only.
Development Guide
gh-agent-workflows/DEVELOPING.md
Updated documentation to clarify that .lock.yml and trigger-*.yml files are auto-generated and should not be edited directly. Added guidance to modify example.yml files and re-run make compile.
Dogfood Script
scripts/dogfood.sh
Modified to output two-line auto-generated header comments at the top of generated trigger files before the main sed-transformed content.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Suggested reviewers

  • github-actions

Poem

🐰 Headers now guard the auto-generated files,
With "don't edit me!" signs that sparkle and smile.
The dogfood script echoes its cautions aloud,
While devs learn to modify examples so proud.
A workflow made clear, no confusion allowed! 🎯

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main change: adding do-not-modify headers to auto-generated trigger files and clarifying their auto-generated status in documentation.
Linked Issues check ✅ Passed All requirements from issue #334 are met: dogfood script adds do-not-modify headers [#334], DEVELOPING.md updated with do-not-edit guidance [#334], and trigger files regenerated with headers [#334].
Out of Scope Changes check ✅ Passed All changes are directly aligned with the stated objectives: header comments in trigger files, documentation updates in DEVELOPING.md, and dogfood.sh modifications to generate headers.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch copilot/update-developing-guide-lock-files

Comment @coderabbitai help to get the list of available commands and usage tips.

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.

Clarify modifying lock files and triggers

2 participants