Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tailcallhq/gh-workflow
Write your github workflows in rust
https://github.com/tailcallhq/gh-workflow
github github-actions github-workflows rust
Last synced: about 11 hours ago
JSON representation
Write your github workflows in rust
- Host: GitHub
- URL: https://github.com/tailcallhq/gh-workflow
- Owner: tailcallhq
- License: apache-2.0
- Created: 2024-10-12T22:16:41.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-01-13T02:36:18.000Z (9 days ago)
- Last Synced: 2025-01-14T17:47:57.694Z (7 days ago)
- Topics: github, github-actions, github-workflows, rust
- Language: Rust
- Homepage: https://docs.rs/gh-workflow/latest
- Size: 406 KB
- Stars: 116
- Watchers: 2
- Forks: 12
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 🦀 Rust GitHub Actions Workflow 🚀
[](https://www.rust-lang.org)
[](https://github.com/tailcallhq/rust-gh-workflow/actions)
[](https://opensource.org/licenses/MIT)
[](https://crates.io/crates/gh-workflow)
[](https://github.com/tailcallhq/rust-gh-workflow/graphs/contributors)
[](https://github.com/tailcallhq/rust-gh-workflow/network/members)
[](https://github.com/tailcallhq/rust-gh-workflow/stargazers)
[](https://github.com/tailcallhq/rust-gh-workflow/issues)
## 🧑💻 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`:
```toml
[build-dependencies]
gh-workflow = "*" # Add the latest version
```
Then you can start creating GitHub Actions in your [tests/ci.rs](https://github.com/tailcallhq/rust-gh-workflow/blob/main/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:
```rust
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](https://github.com/tailcallhq/gh-workflow/blob/main/crates/gh-workflow-tailcall/tests/ci.rs) of this project.
- Run `cargo test` to generate the GitHub Actions workflow.
## 💡 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](LICENSE) file for details.
## 🙌 Contributors
A big thank you to all the contributors who helped make this project a success! 🙏
[](https://github.com/tailcallhq/rust-gh-workflow/graphs/contributors)
## 🌟 Show Your Support
If you like this project, please consider giving it a ⭐ on [GitHub](https://github.com/tailcallhq/rust-gh-workflow) and share it with the community!
## 🔗 Inspiration
This project was inspired by the following repositories:
- [sbt/sbt-github-actions](https://github.com/sbt/sbt-github-actions)
- [emmanuelnk/github-actions-workflow-ts](https://github.com/emmanuelnk/github-actions-workflow-ts)
---
Happy automating with Rust! 🦀❤️