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

Add debug builds to CI #36

Merged
merged 6 commits into from
May 24, 2024
Merged

Add debug builds to CI #36

merged 6 commits into from
May 24, 2024

Conversation

damianhxy
Copy link
Member

@damianhxy damianhxy commented May 22, 2024

This PR fixes the CI to correctly build release builds by changing the way that CMAKE_BUILD_TYPE is handled.

It also adds debug builds to the CI.

To check: view the CI checks and ensure that the correct build type is displayed under the "Configure CMake" task. You can also experiment with combinations of -DCMAKE_BUILD_TYPE and -DRelease, but note that CMAKE_BUILD_TYPE is cached.

@damianhxy damianhxy requested a review from 20wildmanj May 22, 2024 05:22
@damianhxy damianhxy marked this pull request as ready for review May 22, 2024 05:22
Copy link
Contributor

coderabbitai bot commented May 22, 2024

Warning

Rate Limit Exceeded

@damianhxy has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 35 minutes and 49 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 577c2ae and 18fc27e.

Walkthrough

The recent updates aim to enhance the CMake multi-platform workflow and build process. The workflow now supports both Release and Debug configurations, providing increased flexibility. In CMakeLists.txt, the logic dynamically sets CMAKE_BUILD_TYPE based on conditions related to the release option, falling back to Debug when unspecified. These changes offer improved control over build configurations during CI.

Changes

File Change Summary
.github/workflows/cmake-multi-platform.yml Expanded build_type matrix options to include Debug alongside Release.
CMakeLists.txt Updated logic for setting CMAKE_BUILD_TYPE based on release conditions, defaulting to Debug.
README.md Revised build instructions, specifying commands for both debug and release versions.
lib/logger/logger.h Added [[maybe_unused]] attribute to the operator<< function in debug_logger struct.

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

Copy link
Contributor

@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: 0

Outside diff range and nitpick comments (1)
CMakeLists.txt (1)

23-27: Setting of PRINT_DEBUG based on CMAKE_BUILD_TYPE is effective.

Consider adding a comment explaining the purpose of PRINT_DEBUG for future maintainers.

Copy link
Contributor

@20wildmanj 20wildmanj left a comment

Choose a reason for hiding this comment

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

Building locally works for me, changes make sense

Copy link
Contributor

@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: 1

Outside diff range and nitpick comments (5)
README.md (5)

Line range hint 13-13: Correct grammatical error in the description of CMake setup.

The word "setup" should be "set up" when used as a verb.

- CMake is already setup to automatically handle acquiring and setting up rapidjson.
+ CMake is already set up to automatically handle acquiring and setting up rapidjson.

Line range hint 15-15: Simplify language for clarity.

Consider using "before" instead of "prior to" for simplicity and ease of reading.

- Please make sure openssl and libcurl libraries are installed prior to building.
+ Please make sure openssl and libcurl libraries are installed before building.

Line range hint 28-28: Correct grammatical error in the description of the redirect URI.

Remove the redundant possessive pronoun "the" before "your".

- The `redirect_uri` should be `<host>/device_flow_auth_cb` since this application uses the `device_flow` authorization method, where `<host>` is the your Autolab domain.
+ The `redirect_uri` should be `<host>/device_flow_auth_cb` since this application uses the `device_flow` authorization method, where `<host>` is your Autolab domain.

Line range hint 46-46: Clarify the description of the install script.

The phrase "install script" is somewhat ambiguous as "install" is typically a verb. Consider rephrasing for clarity.

- We've written an install script that builds the entire project, installs the binary to your system, and installs the bash autocompletion script.
+ We've written a script that installs the entire project, places the binary on your system, and sets up the bash autocompletion script.

Line range hint 62-62: Correct the grammatical structure involving the command 'cd'.

The use of 'cd' as a verb should be clarified for better readability.

- After installing manually, users can cd out of build and execute the following commands:
+ After installing manually, users can exit the build directory and execute the following commands:

README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@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: 2

Outside diff range and nitpick comments (8)
README.md (8)

Line range hint 13-13: Correct the verb form for setting up dependencies.

- CMake is already setup to automatically handle acquiring and setting up rapidjson.
+ CMake is already set up to automatically handle acquiring and setting up rapidjson.

Line range hint 15-15: Simplify language for clarity.

- Please make sure openssl and libcurl libraries are installed prior to building.
+ Please make sure openssl and libcurl libraries are installed before building.

Line range hint 22-22: Simplify language to enhance readability.

- The program requires client credentials in order to build.
+ The program requires client credentials to build.

Line range hint 28-28: Correct grammatical error.

- where `<host>` is the your Autolab domain.
+ where `<host>` is your Autolab domain.

Line range hint 46-46: Correct the incorrect use of "install" as a noun.

- We've written an install script that builds the entire project,
+ We've written an installation script that builds the entire project,

Line range hint 46-46: Simplify language to enhance readability.

- It needs sudo access in order to copy files to protected directories (details below)
+ It needs sudo access to copy files to protected directories (details below)

Line range hint 51-51: Correct punctuation error.

- run `cmake ..`.
+ run `cmake ..`

Line range hint 62-62: Clarify the action for better understanding.

- After installing manually, users can cd out of build and execute the following commands:
+ After installing manually, users can change directory (cd) out of build and execute the following commands:

README.md Outdated Show resolved Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@damianhxy damianhxy added this pull request to the merge queue May 24, 2024
Merged via the queue into master with commit deee5f7 May 24, 2024
4 checks passed
@damianhxy damianhxy deleted the improve-ci branch May 24, 2024 18:11
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.

None yet

2 participants