docs: hyperlink audit packet, pin bash, explain dep pinning strategy#181
Merged
docs: hyperlink audit packet, pin bash, explain dep pinning strategy#181
Conversation
…trategy (#180) - Embed relative hyperlinks to required docs in AUDITOR_PACKET.md - Add Bash 3.2+ to VERIFY.md prerequisites (scripts/audit/deps.sh uses pipefail and BASH_SOURCE, both requiring Bash 3.0+) - Add "Version Pinning Strategy" section to DEPENDENCIES.md explaining why lockfiles are the pin and manifest ranges are constraints
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 1dafdc220e
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Caret-compatible ranges (serde = "1", revm = "34", etc.) are not exact pins. Clarify that Cargo.lock is what fixes the resolved versions.
Owner
Author
|
Big thanks @pcaversaccio for the review feedback |
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
1 participant
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
Addresses feedback from audit review:
scripts/audit/deps.shusespipefailandBASH_SOURCE[0](both Bash 3.0+), pinned to 3.2 since that's the macOS system version--frozen-lockfile/--lockedTest plan
pipefail+BASH_SOURCE)Note
Low Risk
Low risk: documentation-only changes clarifying dependency/version reproducibility and reviewer workflow; no runtime code or build logic is modified.
Overview
Adds a new “Version Pinning Strategy” section to
DEPENDENCIES.mdexplaining that committed lockfiles (enforced viabun --frozen-lockfileandcargo --locked) are the source of truth, while manifest ranges represent compatibility ceilings.Updates auditor/repro guidance by adding a Bash 3.2+ prerequisite in
VERIFY.mdand convertingdocs/audit/AUDITOR_PACKET.md’s required-docs list into clickable relative links for easier GitHub review navigation.Written by Cursor Bugbot for commit 0dc58b4. This will update automatically on new commits. Configure here.