Repository navigation
fix generate_manual.sh to sync ReadMe.md instead of README.md - #1605
Merged
Merged
Conversation
git tracks the readme as ReadMe.md. On case-sensitive filesystems (Linux, CI) awk could not open README.md, so with `set -euo pipefail` the script aborted right after rewriting Manual.md and never synced the "Common CLI Usage" section. On case-insensitive filesystems the final mv renamed ReadMe.md to README.md in the working tree.
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
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.
generate_manual.shregeneratesManual.mdand then syncs the "## Common CLI Usage" section of the readme (added in d609e9e). It reads and writesREADME.md, but git tracks the file asReadMe.md:awkcannot openREADME.md. Because ofset -euo pipefailthe script exits right after rewritingManual.md, so the readme section is never synced.mvleaves the file renamed toREADME.mdin the working tree.All four references in the script now use
ReadMe.md; nothing else changes.Tested by running the whole script in a
golang:1container.