Merged
Conversation
Contributor
Reviewer's GuideThis PR enhances action helper scripts by echoing each external command before execution for improved transparency and debugging, and updates documentation to reflect this new behavior. Sequence diagram for echoing external commands before execution in action scriptssequenceDiagram
participant Script as Python Action Script
participant Typer as Typer (echo)
participant Shell as Shell/External Command
Script->>Script: Prepare external command (e.g., cargo, uvx, rsync)
Script->>Typer: Echo command string (e.g., "$ cargo install ...")
Typer-->>Script: Command echoed to stdout
Script->>Shell: Execute external command
Shell-->>Script: Command output/result
Class diagram for updated command execution in action scriptsclassDiagram
class ActionScript {
+main()
+prepare_command()
+echo_command()
+execute_command()
}
class Typer {
+echo(str)
}
class ExternalCommand {
+formulate()
+run()
}
ActionScript --> Typer : uses
ActionScript --> ExternalCommand : prepares/executes
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. Warning Rate limit exceeded@leynos has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 1 minutes and 27 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (11)
Summary by CodeRabbit
WalkthroughEchoing of all shell commands before execution has been introduced across various Python action scripts. This involves importing the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Script
participant Shell
User->>Script: Run script with arguments
Script->>Script: Construct command (cmd)
Script->>User: Echo shell command (shlex.join(cmd))
Script->>Shell: Execute command
Shell->>Script: Return output/status
Script->>User: Display result/output
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested labels
Poem
✨ Finishing Touches
🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey @leynos - I've reviewed your changes and found some issues that need to be addressed.
- Consolidate the echo-and-execute pattern into a shared utility to reduce boilerplate across scripts.
- Consider sending command echoes to stderr or making them toggleable to avoid mixing with normal stdout/structured outputs.
- Review whether any sensitive information could be exposed by echoing full commands and consider masking or skipping secrets.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consolidate the echo-and-execute pattern into a shared utility to reduce boilerplate across scripts.
- Consider sending command echoes to stderr or making them toggleable to avoid mixing with normal stdout/structured outputs.
- Review whether any sensitive information could be exposed by echoing full commands and consider masking or skipping secrets.
## Individual Comments
### Comment 1
<location> `.github/actions/generate-coverage/scripts/run_python.py:55` </location>
<code_context>
try:
- python["-m", "coverage", "xml", "-o", str(xml_tmp)]()
+ cmd = python["-m", "coverage", "xml", "-o", str(xml_tmp)]
+ typer.echo(f"$ {shlex.join(cmd.formulate())}")
+ cmd()
except ProcessExecutionError as exc:
</code_context>
<issue_to_address>
Refactor repeated command echoing logic into a helper function to keep code DRY.
The logic for echoing commands before execution is repeated in multiple places. Refactor this into a helper function to avoid duplication and improve maintainability.
</issue_to_address>
### Comment 2
<location> `.github/actions/generate-coverage/scripts/run_rust.py:200` </location>
<code_context>
try:
- python["-m", "coverage", "xml", "-o", str(xml_tmp)]()
+ cmd = python["-m", "coverage", "xml", "-o", str(xml_tmp)]
+ typer.echo(f"$ {shlex.join(cmd.formulate())}")
+ cmd()
except ProcessExecutionError as exc:
</code_context>
<issue_to_address>
Refactor command echoing logic into a reusable function to avoid duplication.
The echoing logic is repeated in several scripts. Refactor it into a helper to keep the code DRY and maintainable.
</issue_to_address>
### Comment 3
<location> `.github/actions/generate-coverage/scripts/install_cargo_llvm_cov.py:19` </location>
<code_context>
try:
- python["-m", "coverage", "xml", "-o", str(xml_tmp)]()
+ cmd = python["-m", "coverage", "xml", "-o", str(xml_tmp)]
+ typer.echo(f"$ {shlex.join(cmd.formulate())}")
+ cmd()
except ProcessExecutionError as exc:
</code_context>
<issue_to_address>
Refactor command echoing into a helper to avoid code duplication.
The echoing logic is repeated. Refactor it into a helper function for better maintainability and DRYness.
</issue_to_address>
### Comment 4
<location> `.github/actions/ratchet-coverage/scripts/run_coverage.py:41` </location>
<code_context>
try:
- python["-m", "coverage", "xml", "-o", str(xml_tmp)]()
+ cmd = python["-m", "coverage", "xml", "-o", str(xml_tmp)]
+ typer.echo(f"$ {shlex.join(cmd.formulate())}")
+ cmd()
except ProcessExecutionError as exc:
</code_context>
<issue_to_address>
Refactor command echoing logic into a helper function to keep code DRY.
The echoing logic is repeated in several places. Refactor it into a helper function to improve code maintainability.
</issue_to_address>
### Comment 5
<location> `.github/actions/setup-rust/scripts/copy_openbsd_stdlib.py:37` </location>
<code_context>
tmp.mkdir(parents=True, exist_ok=True)
cmd = ["rsync", "-a", "--delete", f"{artifact_dir}/", str(tmp)]
+ typer.echo(f"$ {shlex.join(cmd)}")
subprocess.check_call(cmd) # noqa: S603
</code_context>
<issue_to_address>
Refactor command echoing logic into a helper function to keep code DRY.
The echoing logic is repeated in several places. Refactor it into a helper function to improve code maintainability.
</issue_to_address>
### Comment 6
<location> `docs/python-action-scripts.md:20` </location>
<code_context>
command execution. By isolating logic in Python, the composite action YAML
-remains minimal and benefits from better readability and testability.
+remains minimal and benefits from better readability and testability. All
+external commands are echoed before execution to aid debugging and
+transparency.
--- a/.github/actions/generate-coverage/scripts/install_cargo_llvm_cov.py
</code_context>
<issue_to_address>
This line is part of a paragraph that is not wrapped to 80 columns.
Ensure that all lines in paragraphs and bullet points are wrapped to a maximum of 80 columns for readability.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
leynos
deleted the
codex/echo-commands-before-execution-in-python-scripts
branch
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
Testing
make lintmake testhttps://chatgpt.com/codex/tasks/task_e_6891112b81508322b4f73eec4169f68c
Summary by Sourcery
Echo all external commands before execution in GitHub Action helper scripts and update documentation to reflect this behavior
New Features:
Documentation: