ci(gh-workflow): Print unit-test logs on failure executions.

[SharafMohamed]

References

• Depends on fix(gh-workflow): Lock Ubuntu runner to 22.04 as a temporary workaround for #75. #80 in order to compile on Git.

Description

• Modified build.yaml to output the unit-test logs when a unit-test fails on Git.

Validation performed

• Tested that the logs print when a unit-test fails.

Summary by CodeRabbit

• Chores
  • Enhanced the build workflow by adding an automated step that outputs detailed test logs when tests fail, improving the diagnosis of issues during development.

[coderabbitai]

Warning

Rate limit exceeded

@SharafMohamed has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 17 minutes and 33 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

📥 Commits

Reviewing files that changed from the base of the PR and between 71fbb9c and 55272ef.

📒 Files selected for processing (1)

• .github/workflows/build.yaml (3 hunks)

Walkthrough

The change adds a new step to the GitHub Actions build workflow. This step, titled "Print test log on failure", is executed only if previous steps fail, as determined by the condition if: "failure()". When this condition is met, the step outputs the contents of the log file located at ./build/Testing/Temporary/LastTest.log. No modifications were made to any exported or public entities.

Changes

File	Change Summary
.github/workflows/build.yaml	Added a job step ("Print test log on failure") that executes on failure, printing the contents of ./build/Testing/Temporary/LastTest.log.

Sequence Diagram(s)

sequenceDiagram
    participant CA as GitHub Actions
    participant T as Test Executor
    participant L as Log Printer

    CA->>T: Execute test suite
    alt Tests succeed
        T-->>CA: Return success status
    else Tests fail
        T-->>CA: Return failure status
        CA->>L: Run "Print test log on failure" (cat ./build/Testing/Temporary/LastTest.log)
        L-->>CA: Output log details
    end

Loading

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[LinZhihao-723]

For the PR title, how about:

ci(gh-workflow): Print unit-test logs on failure executions.