Introduce GitHub Actions

[nao1215]

Summary by CodeRabbit

• New Features

  • Introduced continuous integration workflows for Rust projects to automate builds and run unit tests.
  • Enhanced build log readability with colorized output.

• Chores

  • Set up triggers for automated builds and tests on pushes and pull requests to the main branch.
  • Improved documentation and examples for the Investment and YearlySummary structures.

[coderabbitai]

Walkthrough

The newly introduced GitHub Actions workflows, build.yml and test.yml, establish a comprehensive continuous integration system for Rust projects. These workflows trigger on pushes and pull requests to the main branch, automating the build and testing processes. They ensure clearer log output and facilitate efficient development by checking out the repository and executing Rust build commands, thereby enhancing code quality and reliability with each update.

Changes

File Path	Change Summary
.github/workflows/build.yml	Introduced a new workflow named Build, triggered on push and pull requests to main. Set CARGO_TERM_COLOR to always. Added a job build which checks out the repo and runs cargo build --verbose.
.github/workflows/test.yml	Introduced a new workflow named Unit tests, triggered on push and pull requests to main. Added a job build that checks out the repo and runs cargo build --verbose.
src/calculations.rs	Enhanced documentation and updated examples for Investment and YearlySummary. Added unit tests for Investment, validating initialization and yearly summary calculations.

Poem

🐇 In the meadow of code, we dance and play,
A build is born, brightening the day!
With colors that sparkle, and logs that sing,
Rust projects flourish, oh what joy they bring!
Hopping through changes, our hearts filled with cheer,
Continuous integration, let’s give a loud cheer! 🎉

---

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.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

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

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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9e4480e and f5afc58.

Files selected for processing (1)

• .github/workflows/build.yml (1 hunks)

Additional comments not posted (5)

.github/workflows/build.yml (5)

1-2: LGTM!

The workflow name is clear and descriptive.

---

3-7: LGTM!

The triggers for the workflow are appropriate and follow best practices.

---

9-11: LGTM!

Setting the CARGO_TERM_COLOR environment variable to always improves the readability of the build output.

---

12-15: LGTM!

The job configuration is standard and appropriate for a Rust project.

---

17-20: LGTM!

The steps for checking out the repository and running the Rust build command are necessary and sufficient for building the project.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f5afc58 and 45d9d76.

Files selected for processing (3)

• .github/workflows/build.yml (1 hunks)
• .github/workflows/test.yml (1 hunks)
• src/calculations.rs (4 hunks)

Files skipped from review as they are similar to previous changes (1)

• .github/workflows/build.yml

Additional comments not posted (10)

.github/workflows/test.yml (4)

1-7: LGTM! Workflow name and trigger conditions are appropriate.

The workflow is named "Unit tests" and is triggered on push and pull requests to the "main" branch, which is a standard practice.

---

9-10: LGTM! Environment variable setup is appropriate.

The environment variable CARGO_TERM_COLOR is set to always, which ensures colored output in logs for better readability.

---

12-15: LGTM! Job configuration is appropriate.

The job is named build and runs on ubuntu-latest, which is a common and suitable choice for CI/CD workflows.

---

17-20: LGTM! Job steps are appropriate.

The job steps include checking out the repository and running cargo build --verbose, which are essential steps for building a Rust project.

src/calculations.rs (6)

Line range hint 31-38:
LGTM! Documentation and example usage are correctly updated.

The documentation and example usage for the Investment struct have been updated to reflect the use of clap::Command instead of clap::App, providing clear and accurate information.

---

Line range hint 39-57:
LGTM! from_matches function is correctly implemented.

The from_matches function correctly parses the command line arguments and handles default values appropriately, ensuring robust initialization of the Investment struct.

---

Line range hint 71-78:
LGTM! Documentation and example usage are correctly added.

The documentation and example usage for the yearly_summary function provide clear and accurate information, enhancing the usability of the function.

---

Line range hint 79-98:
LGTM! yearly_summary function is correctly implemented.

The yearly_summary function correctly calculates the yearly summary of the investment, handling edge cases appropriately and ensuring accurate results.

---

Line range hint 141-149:
LGTM! Documentation and example usage are correctly added.

The documentation and example usage for the plot_summary function provide clear and accurate information, enhancing the usability of the function.

---

210-267: LGTM! Test cases are comprehensive and well-implemented.

The test cases for the Investment struct comprehensively cover the functionality and edge cases, ensuring robust validation of the initialization and yearly summary generation.