docs: enhance Docker usage instructions in README #9
Conversation
- Change push-to-registry to false in `ghcr.yml`
- Expand Docker instructions with additional options and environment variables - Add note about write access for --commit option - Include --yes option tip
WalkthroughThis pull request introduces modifications to the CI workflow and Docker usage documentation. In the workflow file, a new step is added to generate an artifact attestation with the Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as Developer
participant GH as GitHub Actions
participant Attester as Artifact Attestation Step
participant Registry as Container Registry
Dev->>GH: Push commit with changes
GH->>Attester: Run workflow job "build-and-push-image"
Attester->>Attester: Generate artifact attestation (push-to-registry=false)
Attester-->>GH: Completion without pushing
GH-->>Dev: Workflow finished
Possibly related PRs
Suggested labels
Poem
Tip ⚡🧪 Multi-step agentic review comment chat (experimental)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
mingcheng
added
documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
93-93: Minor Grammar Improvement:
Consider revising “skip the confirm” to “skip the confirmation” for improved clarity and grammatical accuracy.Proposed diff:
-Tips: You can add `--yes` options to skip the confirm. +Tips: You can add `--yes` options to skip the confirmation.🧰 Tools
🪛 LanguageTool
[grammar] ~93-~93: The word ‘confirm’ is not a noun. Did you mean “confirmation”?
Context: ...You can add--yesoptions to skip the confirm. ### Git Hook TheAIGitCommitalso...(PREPOSITION_VERB)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.github/workflows/ghcr.yml(1 hunks)README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~93-~93: The word ‘confirm’ is not a noun. Did you mean “confirmation”?
Context: ...You can add --yes options to skip the confirm. ### Git Hook The AIGitCommit also...
(PREPOSITION_VERB)
⏰ Context from checks skipped due to timeout of 90000ms (5)
- GitHub Check: Rust project - latest (beta)
- GitHub Check: Rust project - latest (stable)
- GitHub Check: Rust project - latest (nightly)
- GitHub Check: Rust project - latest (stable)
- GitHub Check: Rust project - latest (beta)
🔇 Additional comments (3)
.github/workflows/ghcr.yml (1)
51-56: New Artifact Attestation Step:
The newly added step for generating an artifact attestation usingactions/attest-build-provenance@v2is well integrated. However, please verify that settingpush-to-registry: falseis intentional for your workflow—this configuration change affects how and where the attestation artifact will be handled.README.md (2)
69-77: Docker Run Command Update (Read-Only Mode):
The command now uses-v $PWD:/repo:ro, which enhances compatibility by referring explicitly to the present working directory. The added environment variables (includingOPENAI_API_PROXY) further clarify usage. This update makes the Docker instructions clearer and more user-friendly.
79-91: Docker Run Command Update (Writable Mode for--commitOption):
The revised instructions for the--commitoption now switch the volume mount to-v $PWD:/repo:rwand include the-itflag for interactive terminal support. This ensures that the/repodirectory is writable, which is necessary for commit operations. The changes are clear and align well with the overall documentation improvements.
Summary by CodeRabbit
Chores
Documentation