Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: capture script failures properly #159

Merged
merged 5 commits into from
Jan 27, 2025
Merged

Conversation

alex-liang3
Copy link
Contributor

@alex-liang3 alex-liang3 commented Jan 24, 2025

Merge this into main AFTER #158

Duplicates #156, which was accidentally merged into the wrong base

Closes open-space-collective/open-space-toolkit-core#182

Summary by CodeRabbit

  • Chores
    • Enhanced error handling in development helper scripts for C++ and Python formatting and testing
    • Added explicit error exit conditions to prevent script continuation on command failures
    • Improved robustness of development tooling by terminating scripts when formatting or testing encounters errors

@alex-liang3 alex-liang3 self-assigned this Jan 24, 2025
Copy link

coderabbitai bot commented Jan 24, 2025

Walkthrough

The pull request focuses on enhancing error handling across several development helper scripts in the tools/development/helpers/ directory. The modifications consistently add || exit 1 to various command executions, ensuring that if a command fails (such as clang-format, black, or pytest), the script will immediately terminate with an exit status of 1. This approach improves script robustness by preventing further execution after encountering formatting or testing errors.

Changes

File Change Summary
tools/development/helpers/check-format-cpp.sh Added error handling for clang-format command
tools/development/helpers/check-format-python.sh Added error handling for black formatting check
tools/development/helpers/format-cpp.sh Added error handling for clang-format command
tools/development/helpers/format-python.sh Added error handling for black formatting command
tools/development/helpers/test-python.sh Added error handling for pytest execution

Possibly related PRs

Suggested reviewers

  • vishwa2710

Poem

🐰 Coding Rabbit's Error Handling Delight

Scripts now exit with a mighty might
When formats fail or tests go astray
No more silent errors to delay
Robust and clean, our code takes flight! 🚀


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@apaletta3 apaletta3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After discussing with Alex, I think all these changes are fine and won't change anything without local dev experience due to the way errors are raised in shells and subshells. Looks good

Base automatically changed from ci/fix-intermittent-qemu-issues to main January 24, 2025 18:48
@alex-liang3 alex-liang3 force-pushed the ci/fail-checks-properly branch from 4ac5190 to 3cf786b Compare January 25, 2025 16:46
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between db3ca6e and 3cf786b.

📒 Files selected for processing (5)
  • tools/development/helpers/check-format-cpp.sh (1 hunks)
  • tools/development/helpers/check-format-python.sh (1 hunks)
  • tools/development/helpers/format-cpp.sh (1 hunks)
  • tools/development/helpers/format-python.sh (1 hunks)
  • tools/development/helpers/test-python.sh (1 hunks)
🧰 Additional context used
🪛 Shellcheck (0.10.0)
tools/development/helpers/test-python.sh

[error] 10-10: Double quote array expansions to avoid re-splitting elements.

(SC2068)

tools/development/helpers/format-cpp.sh

[warning] 9-9: Quote this to prevent word splitting.

(SC2046)

tools/development/helpers/check-format-cpp.sh

[warning] 9-9: Quote this to prevent word splitting.

(SC2046)

🔇 Additional comments (5)
tools/development/helpers/format-python.sh (1)

9-10: LGTM! Proper error handling added.

The addition of || exit 1 ensures the script fails fast if the black formatter encounters any issues.

tools/development/helpers/check-format-python.sh (1)

9-10: LGTM! Proper error handling added.

The addition of || exit 1 ensures the script fails fast if the black formatter check detects any formatting issues.

tools/development/helpers/test-python.sh (1)

10-11: LGTM! Proper error handling added.

The addition of || exit 1 ensures the script fails fast if any tests fail.

🧰 Tools
🪛 Shellcheck (0.10.0)

[error] 10-10: Double quote array expansions to avoid re-splitting elements.

(SC2068)

tools/development/helpers/format-cpp.sh (1)

9-10: LGTM! Proper error handling added.

The addition of || exit 1 ensures the script fails fast if clang-format encounters any issues.

🧰 Tools
🪛 Shellcheck (0.10.0)

[warning] 9-9: Quote this to prevent word splitting.

(SC2046)

tools/development/helpers/check-format-cpp.sh (1)

9-10: LGTM! Proper error handling added.

The addition of || exit 1 ensures the script fails fast if clang-format check detects any formatting issues.

🧰 Tools
🪛 Shellcheck (0.10.0)

[warning] 9-9: Quote this to prevent word splitting.

(SC2046)

tools/development/helpers/test-python.sh Show resolved Hide resolved
tools/development/helpers/format-cpp.sh Show resolved Hide resolved
tools/development/helpers/check-format-cpp.sh Show resolved Hide resolved
@alex-liang3 alex-liang3 merged commit 9f35793 into main Jan 27, 2025
4 checks passed
@alex-liang3 alex-liang3 deleted the ci/fail-checks-properly branch January 27, 2025 10:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants