Development: Use GitHub to build coverage tables

[undernagruzez]

Checklist

General

• I chose a title conforming to the naming conventions for pull requests.

Motivation and Context

Bamboo is used as source for the coverage artifacts. Now, Github will upload the artifacts too and the script will use them.

Description

The 'Test' workflow has been adapted. 'generate_code_cov_table.py' has been adapted.

Steps for Testing

This PR is difficult to test as there are no code changes and therefore no test coverage. But, I didn't change the part related to generation of the coverage table. Follow the rules described in supporting_scripts/generate_code_cov_table/README.md and make sure no error is thrown. Important: this branch should be active.

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

[coderabbitai]

Warning

Rate Limit Exceeded

@undernagruzez has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 21 minutes and 17 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

Files that changed from the base of the PR and between af0c90e and 0b320c2.

Walkthrough

The recent updates focus on transitioning the code coverage report generation and uploading processes from Bamboo to GitHub. The GitHub Actions workflow now includes steps to upload server and client test coverage reports. The supporting script for generating the coverage table has been refactored to interact with GitHub, requiring a GitHub token for authentication instead of Bamboo credentials. This involves changes in environment variable names, script arguments, and the addition of new functions to handle GitHub API interactions.

Changes

File Path	Summary
.github/workflows/test.yml	Added steps to upload server and client test coverage reports in the GitHub Actions workflow.
supporting_scripts/generate_code_cov_table/README.md	Updated instructions to use GitHub token instead of Bamboo credentials and changed script arguments.
supporting_scripts/generate_code_cov_table/env.example	Renamed environment variables from BAMBOO_USERNAME and BAMBOO_PASSWORD to TOKEN.
supporting_scripts/generate_code_cov_table/generate_code_cov_table.py	Refactored script to interact with GitHub for coverage data, added functions for downloading, extracting, and processing coverage artifacts.

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[coderabbitai]

Actionable comments posted: 5

[coderabbitai]

Actionable comments posted: 2

[Hialus]

Code looks good and I ran it locally, though that is obviously an imperfect test, without any data. Do you have any PR that you could base on top of this, so we have a realistic example? Could also just be a test PR.

I left 2 small nitpick comments that you may want to implement.

[undernagruzez]

Do you have any PR that you could base on top of this, so we have a realistic example?

Thanks for your review @Hialus. I have a currently open PR, but it has to be merged soon. I'll open another PR soon, whose review should take assumingly longer than this one, so unnecessary diff will be gone, I'll let you know.

[rstief]

Overall LGTM, just two small comments.

[coderabbitai]

Actionable comments posted: 1

Not important

[muradium]

Reapproval

[coolchock]

re-approve

[maximiliansoelch]

Thanks for implementing my suggestions 👍