Document CLAUDE.md learnings from 0.64.0 release cycle - #385
Merged
Conversation
Two learnings from the 0.64.0 release cycle: verify reviewer claims about YAML validity with an actual parser rather than trusting them, and expect open PR branches to sometimes receive direct pushes from the user outside the session. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Documents two operational learnings from the 0.63.1/0.64.0 release cycle in CLAUDE.md to reduce recurring review and workflow mistakes when maintaining this GitHub Action.
Changes:
- Adds guidance to validate “invalid YAML” claims with an actual YAML parser (and notes about same-indentation block sequences).
- Adds guidance about open PR branches potentially receiving direct pushes mid-session, and the need to fetch/merge before pushing.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## README YAML Examples | ||
|
|
||
| - Inputs under `with:` in workflow YAML examples must be indented 2 spaces relative to `with:`. This has been a recurring source of invalid examples. | ||
| - Don't trust a reviewer's (e.g. Copilot's) "this is invalid YAML" claim at face value — verify with `python3 -c "import yaml; yaml.safe_load(open('README.md').read())"` on the extracted block. Same-indentation block sequences (list items aligned with their parent key) are valid YAML even though they look wrong; the real issue is usually inconsistency with this file's convention, not invalidity. |
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.
Summary
CLAUDE.mdnotes from working through the Strange problem with source matching with 0.63.0 #378/Bump bracex from 2.5.post1 to 3.0.1 to fix glob source matching #379/Adopt pip-compile for Python dependency management #380/0.63.1/0.64.0 cycle:🤖 Generated with Claude Code