Document cross-platform portability and release gotchas in AGENTS.md#174
Merged
Conversation
Recent sessions kept re-discovering the same two classes of late failure because the lessons lived only in PR bodies, not the AGENTS.md guidance files that every session reads: - tests/AGENTS.md gains a "Cross-platform portability" section: the full check.sh gate is Linux-only, but CI runs pytest on Windows and maintainers gate on macOS. Records the termios/importorskip, POSIX-only permission-bit, case-insensitive-FS, and BSD-grep / brew-audit-by-name gotchas that cost #162/#163 follow-up PRs. - AGENTS.md gains the release-run operational gotchas behind #165/#166: the GITHUB_TOKEN-authored formula PR doesn't trigger CI (admin-override merge), and the workflow_dispatch tag job must set a git identity before cut_release.sh cuts its annotated tag.
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
2 participants
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
Add guidance to
tests/AGENTS.mdandAGENTS.mddocumenting hard-won lessons about cross-platform testing and release automation that have each cost prior sessions a follow-up PR.Changes
tests/AGENTS.md: New "Cross-platform portability" section documenting four categories of OS-specific failures that don't surface on Linux but break on Windows or macOS:
pytest.importorskip()at module scope, not skip markersos.name == "posix"while testing cross-platform behavior unconditionallycheck.sh(grep -E vs -P, brew audit by name not path)AGENTS.md: New "Release-run operational gotchas" subsection documenting two issues specific to the
release.ymlworkflow:GITHUB_TOKENwhich doesn't trigger CI, requiring admin override to mergeworkflow_dispatchtagjob must set git identity before callingcut_release.sh(which creates annotated tags requiring committer info)Rationale
These sections capture patterns that repeatedly catch maintainers and agents: a green Linux gate doesn't guarantee green macOS/Windows runs, and release automation has subtle credential/identity requirements. Documenting them upfront prevents future follow-up PRs.
https://claude.ai/code/session_0188anNrEdHn2SHHDPCkoKVR