docs(scripts): keep the composer portable and its comment repository-neutral - #174
Merged
Conversation
…neutral The paired test used sed -i, whose in-place flag differs between GNU and BSD sed, so a contributor on macOS could not run it; it now rewrites through a temp file. The namespace comment named this repository's two lines, which read as a tag convention in the contract repositories that carry the same script; it now describes the two shapes generically. Signed-off-by: Rob Konsdorf <rob@facings.io>
There was a problem hiding this comment.
Pull request overview
This PR improves the portability and reusability of the release-notes script suite across different environments and repositories by removing GNU/BSD sed incompatibilities in the paired test and making the tag-namespace comment repository-neutral.
Changes:
- Replaced
sed -iusage inscripts/release-notes.test.shwith a temp-file rewrite to work consistently on GNU and BSDsed. - Updated the tag-shape/namespace explanatory comment in
scripts/release-notes.shto describe tag conventions generically (portable across contract repositories).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| scripts/release-notes.test.sh | Avoids sed -i portability issues by rewriting CHANGELOG.md via a temp file + mv. |
| scripts/release-notes.sh | Adjusts the tag-namespace comment to be repository-neutral while preserving the existing behavior. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
Why
The paired test used
sed -i, whose in-place flag differs between GNU and BSD sed, so a contributor on macOS could not run it; it now rewrites through a temp file. The namespace comment inscripts/release-notes.shnamed this repository's two lines, which reads as a tag convention in the contract repositories that carry the same script byte for byte; it now describes the two tag shapes generically. Same change rides in atomicassets/atomicassets-contract#33 and atomicassets/atomicmarket-contract#18.Validation
bash scripts/release-notes.test.sh12/12; shellcheck clean; the three copies are byte-identical.