README.md

🦀 Rust GitHub Actions Workflow 🚀

🧑‍💻 What is Rust GitHub Workflows?

Rust GitHub Workflows is a library that allows developers to write GitHub Actions in Rust. It empowers you to automate, manage, and improve your CI/CD pipelines in a type-safe manner.

GitHub Actions is powerful, but writing workflows can sometimes feel repetitive, tricky and frustrating with no strict type-checking. That's where Rust GitHub Workflows steps in! 🦾

• 🔥 Rust-Powered: Leverage the type-safety of Rust for writing workflows.
• 📦 Crate-friendly: Build reusable workflows and publish them as crates.

📦 Installation

To use Rust GitHub Workflows in your project, add it to your Cargo.toml:

[build-dependencies]
gh-workflow = "*" # Add the latest version

Then you can start creating GitHub Actions in your tests/ci.rs.

👷 Usage

• Simply add a tests/ci.rs file to your project's tests directory.

• Add the following code to generate the GitHub Actions workflow:

  use gh_workflows::*;
  
  #[test]
  fn main() {
      // Create a basic workflow
      let workflow = Workflow::setup_rust();
  
      // Generate the ci.yml
      workflow.generate().unwrap();
  }

  To view a fully functional example, check out the tests/ci.rs of this project.

• Run cargo test to generate the GitHub Actions workflow.

🛠️ Roadmap

• Support for Automated Cargo Releases
• Improve Type Safety of Nightly Builds
• Updates Rust Docs using Github's official documentation for the API

💡 Why Rust?

Rust provides the perfect combination of speed, safety, and flexibility, making it an ideal choice for writing GitHub Actions. With Rust, you get strong typing, memory safety, and the ability to reuse existing code, which can make your automation scripts more robust and maintainable.

📄 License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.

🙌 Contributors

A big thank you to all the contributors who helped make this project a success! 🙏

🌟 Show Your Support

If you like this project, please consider giving it a ⭐ on GitHub and share it with the community!

🔗 Inspiration

This project was inspired by the following repositories:

• sbt/sbt-github-actions
• emmanuelnk/github-actions-workflow-ts

---

Happy automating with Rust! 🦀❤️