GitAuto: [FEATURE] Add support to Cargo/Crates - Rust

[gitauto-ai]

Resolves #230

What is the feature

We are adding support to publish this project as a Rust crate to Crates.io, the official Rust package registry. This will enable Rust developers to easily integrate the functionalities provided by this repository into their projects using Cargo, Rust's package manager.

Why we need the feature

Publishing the project as a Rust crate offers several benefits:

1. Easy Installation: Developers can add the crate as a dependency in their Cargo.toml, simplifying the installation process.
2. Version Control: Crates.io supports versioning, enabling developers to depend on specific versions of the package.
3. Distribution: Being on Crates.io, the central repository for Rust libraries, increases the project's visibility and accessibility to the Rust community.

How to implement and why

To implement this feature, we will follow these steps:

1. Create or Update the Cargo.toml File:

   • Add a Cargo.toml file at the root of the project if it doesn't exist.

   • Include necessary package metadata such as name, version, description, authors, and license.

   • Example Cargo.toml:

     [package]
     name = "bancos_brasileiros"
     version = "0.1.0"
     authors = ["Your Name <[email protected]>"]
     edition = "2021"
     description = "A Rust crate for Brazilian bank data"
     license = "MIT OR Apache-2.0"
     repository = "https://github.com/username/repository"
     
     [dependencies]
     # Add any crate dependencies here

   • This file informs Cargo about the package details and dependencies.

2. Organize the Rust Code:

   • Place the Rust source files in the src directory, following standard Rust project structure.
   • Ensure there's a lib.rs file in src for a library crate.
   • This organization allows Cargo to correctly build and package the crate.

3. Configure as a Library Crate:

   • If the project is not already a library crate, modify it by adding a lib.rs file.
   • Export the public API through pub declarations in lib.rs.
   • Configuring as a library crate allows other projects to use it as a dependency.

4. Add Documentation and Examples:

   • Use Rust doc comments (///) to document the public API.
   • Provide usage examples in the documentation and/or an examples directory.
   • Good documentation helps developers understand how to use the crate effectively.

5. Verify the Crate Locally:

   • Run cargo build to ensure the crate builds successfully.
   • Execute cargo test to confirm all tests pass.
   • Use cargo package to simulate the packaging process and verify all files are included.

6. Publish to Crates.io:

   • Ensure you have a Crates.io account and obtain an API token.

   • Authenticate with cargo login <token>.

   • Publish the crate using:

     cargo publish

   • Publishing makes the crate available for others to use via Cargo.

7. Update Documentation:

   • Add instructions to README.md on how to include the crate in other projects:

     ## Installation
     
     Add this to your `Cargo.toml`:
     
     ```toml
     [dependencies]
     bancos_brasileiros = "0.1.0"

   • Include a Crates.io badge in README.md for easy access:

     [![Crates.io](https://img.shields.io/crates/v/bancos_brasileiros.svg)](https://crates.io/crates/bancos_brasileiros)

8. Consider Continuous Integration:

   • Set up CI workflows (e.g., GitHub Actions) to automate testing and ensure code quality.
   • Automate the publishing process for future releases if appropriate.

9. Follow Best Practices:

   • Adhere to Rust's best practices for crate publishing.
   • Ensure the crate does not include unnecessary files by adding a .gitignore and, if needed, an explicit include/exclude list in Cargo.toml.

Reasoning:

• Creating a proper Cargo.toml file with accurate metadata is crucial for Cargo and Crates.io to recognize and display the package correctly.
• Organizing code according to Rust conventions ensures compatibility and ease of use for developers.
• Documentation and examples enhance the usability of the crate, encouraging adoption.
• Verifying the crate locally before publishing prevents issues that could surface after release.
• Updating the README and adding badges improves visibility and provides essential information to users.

About backward compatibility

As this is the initial release of the Rust crate, backward compatibility with previous Rust versions or APIs is not a concern. Moving forward, we should:

• Adhere to Semantic Versioning: Use version numbers to indicate breaking changes (major), new features (minor), and bug fixes (patch).
• Maintain Stability: Avoid breaking changes to the public API in minor and patch releases.
• Communicate Changes: Clearly document any changes in the CHANGELOG and update documentation accordingly.

By considering backward compatibility from the outset, we can provide a reliable and stable experience for developers who adopt the crate.

Test these changes locally

git checkout -b gitauto/issue-#230-d915bc33-e153-4495-bb3c-cef91c303b65
git pull origin gitauto/issue-#230-d915bc33-e153-4495-bb3c-cef91c303b65

[github-actions]

Infisical secrets check: ✅ No secrets leaked!

💻 Scan logs

12:09AM INF scanning for exposed secrets...
12:09AM INF 1001 commits scanned.
12:09AM INF scan completed in 2.64s
12:09AM INF no leaks found

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud