Merge pull request #13 from bahdotsh/bahdotsh/trigger_wrkflws

feat: add workflow_dispatch trigger command
This commit is contained in:
Gokul
2025-04-21 12:17:45 +05:30
committed by GitHub
6 changed files with 601 additions and 0 deletions

12
.github/workflows/test.yml vendored Normal file
View File

@@ -0,0 +1,12 @@
name: Test
on:
workflow_dispatch:
jobs:
test:
runs-on: 'ubuntu-latest'
steps:
- name: Hey
run: |
echo hello && echo world

284
Cargo.lock generated
View File

@@ -290,6 +290,16 @@ dependencies = [
"windows-sys 0.59.0",
]
[[package]]
name = "core-foundation"
version = "0.9.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "91e195e091a93c46f7102ec7818a2aa394e1e1771c3ab4825963fa03e45afb8f"
dependencies = [
"core-foundation-sys",
"libc",
]
[[package]]
name = "core-foundation-sys"
version = "0.8.7"
@@ -410,6 +420,15 @@ version = "1.15.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "48c757948c5ede0e46177b7add2e67155f70e33c07fea8284df6576da70b3719"
[[package]]
name = "encoding_rs"
version = "0.8.35"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "75030f3c4f45dafd7586dd6780965a8c7e8e285a5ecb86713e63a79c5b2766f3"
dependencies = [
"cfg-if",
]
[[package]]
name = "equivalent"
version = "1.0.2"
@@ -450,6 +469,21 @@ version = "1.0.7"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3f9eec918d3f24069decb9af1554cad7c880e2da24a9afd88aca000531ab82c1"
[[package]]
name = "foreign-types"
version = "0.3.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f6f339eb8adc052cd2ca78910fda869aefa38d22d5cb648e6485e4d3fc06f3b1"
dependencies = [
"foreign-types-shared",
]
[[package]]
name = "foreign-types-shared"
version = "0.1.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "00b0228411908ca8685dba7fc2cdd70ec9990a6e753e89b6ac91a84c40fbaf4b"
[[package]]
name = "form_urlencoded"
version = "1.2.1"
@@ -699,6 +733,19 @@ dependencies = [
"want",
]
[[package]]
name = "hyper-tls"
version = "0.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d6183ddfa99b85da61a140bea0efc93fdf56ceaa041b37d553518030827f9905"
dependencies = [
"bytes",
"hyper",
"native-tls",
"tokio",
"tokio-native-tls",
]
[[package]]
name = "hyperlocal"
version = "0.8.0"
@@ -903,6 +950,12 @@ version = "2.0.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f4c7245a08504955605670dbf141fceab975f15ca21570696aebe9d2e71576bd"
[[package]]
name = "ipnet"
version = "2.11.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "469fb0b9cefa57e3ef31275ee7cacb78f2fdca44e4765491884a2b119d4eb130"
[[package]]
name = "is_terminal_polyfill"
version = "1.70.1"
@@ -997,6 +1050,12 @@ version = "2.7.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "78ca9ab1a0babb1e7d5695e3530886289c18cf2f87ec19a575a0abdce112e3a3"
[[package]]
name = "mime"
version = "0.3.17"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6877bb514081ee2a7ff5ef9de3281f14a4dd4bceac4c09388074a6b5df8a139a"
[[package]]
name = "miniz_oxide"
version = "0.8.5"
@@ -1029,6 +1088,23 @@ dependencies = [
"windows-sys 0.52.0",
]
[[package]]
name = "native-tls"
version = "0.2.14"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "87de3442987e9dbec73158d5c715e7ad9072fda936bb03d19d7fa10e00520f0e"
dependencies = [
"libc",
"log",
"openssl",
"openssl-probe",
"openssl-sys",
"schannel",
"security-framework",
"security-framework-sys",
"tempfile",
]
[[package]]
name = "num-conv"
version = "0.1.0"
@@ -1069,6 +1145,50 @@ version = "1.21.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c2806eaa3524762875e21c3dcd057bc4b7bfa01ce4da8d46be1cd43649e1cc6b"
[[package]]
name = "openssl"
version = "0.10.72"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "fedfea7d58a1f73118430a55da6a286e7b044961736ce96a16a17068ea25e5da"
dependencies = [
"bitflags 2.9.0",
"cfg-if",
"foreign-types",
"libc",
"once_cell",
"openssl-macros",
"openssl-sys",
]
[[package]]
name = "openssl-macros"
version = "0.1.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a948666b637a0f465e8564c73e89d4dde00d72d4d473cc972f390fc3dcee7d9c"
dependencies = [
"proc-macro2",
"quote",
"syn",
]
[[package]]
name = "openssl-probe"
version = "0.1.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d05e27ee213611ffe7d6348b942e8f942b37114c00cc03cec254295a4a17852e"
[[package]]
name = "openssl-sys"
version = "0.9.107"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8288979acd84749c744a9014b4382d42b8f7b2592847b5afb2ed29e5d16ede07"
dependencies = [
"cc",
"libc",
"pkg-config",
"vcpkg",
]
[[package]]
name = "option-ext"
version = "0.2.0"
@@ -1142,6 +1262,12 @@ version = "0.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8b870d8c151b6f2fb93e84a13146138f05d02ed11c7e7c54f8826aaaf7c9f184"
[[package]]
name = "pkg-config"
version = "0.3.32"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7edddbd0b52d732b21ad9a5fab5c704c14cd949e5e9a1ec5929a24fded1b904c"
[[package]]
name = "powerfmt"
version = "0.2.0"
@@ -1258,6 +1384,46 @@ version = "0.8.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2b15c43186be67a4fd63bee50d0303afffcef381492ebe2c5d87f324e1b8815c"
[[package]]
name = "reqwest"
version = "0.11.27"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "dd67538700a17451e7cba03ac727fb961abb7607553461627b97de0b89cf4a62"
dependencies = [
"base64 0.21.7",
"bytes",
"encoding_rs",
"futures-core",
"futures-util",
"h2",
"http",
"http-body",
"hyper",
"hyper-tls",
"ipnet",
"js-sys",
"log",
"mime",
"native-tls",
"once_cell",
"percent-encoding",
"pin-project-lite",
"rustls-pemfile",
"serde",
"serde_json",
"serde_urlencoded",
"sync_wrapper",
"system-configuration",
"tokio",
"tokio-native-tls",
"tower-service",
"url",
"wasm-bindgen",
"wasm-bindgen-futures",
"web-sys",
"winreg",
]
[[package]]
name = "rustc-demangle"
version = "0.1.24"
@@ -1290,6 +1456,15 @@ dependencies = [
"windows-sys 0.59.0",
]
[[package]]
name = "rustls-pemfile"
version = "1.0.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1c74cae0a4cf6ccbbf5f359f08efdf8ee7e1dc532573bf0db71968cb56b1448c"
dependencies = [
"base64 0.21.7",
]
[[package]]
name = "rustversion"
version = "1.0.20"
@@ -1302,12 +1477,44 @@ version = "1.0.20"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "28d3b2b1366ec20994f1fd18c3c594f05c5dd4bc44d8bb0c1c632c8d6829481f"
[[package]]
name = "schannel"
version = "0.1.27"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1f29ebaa345f945cec9fbbc532eb307f0fdad8161f281b6369539c8d84876b3d"
dependencies = [
"windows-sys 0.59.0",
]
[[package]]
name = "scopeguard"
version = "1.2.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49"
[[package]]
name = "security-framework"
version = "2.11.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "897b2245f0b511c87893af39b033e5ca9cce68824c4d7e7630b5a1d339658d02"
dependencies = [
"bitflags 2.9.0",
"core-foundation",
"core-foundation-sys",
"libc",
"security-framework-sys",
]
[[package]]
name = "security-framework-sys"
version = "2.14.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "49db231d56a190491cb4aeda9527f1ad45345af50b0851622a7adb8c03b01c32"
dependencies = [
"core-foundation-sys",
"libc",
]
[[package]]
name = "serde"
version = "1.0.219"
@@ -1497,6 +1704,12 @@ dependencies = [
"unicode-ident",
]
[[package]]
name = "sync_wrapper"
version = "0.1.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2047c6ded9c721764247e62cd3b03c09ffc529b2ba5b10ec482ae507a4a70160"
[[package]]
name = "synstructure"
version = "0.13.1"
@@ -1508,6 +1721,27 @@ dependencies = [
"syn",
]
[[package]]
name = "system-configuration"
version = "0.5.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ba3a3adc5c275d719af8cb4272ea1c4a6d668a777f37e115f6d11ddbc1c8e0e7"
dependencies = [
"bitflags 1.3.2",
"core-foundation",
"system-configuration-sys",
]
[[package]]
name = "system-configuration-sys"
version = "0.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a75fb188eb626b924683e3b95e3a48e63551fcfb51949de2f06a9d91dbee93c9"
dependencies = [
"core-foundation-sys",
"libc",
]
[[package]]
name = "tar"
version = "0.4.44"
@@ -1622,6 +1856,16 @@ dependencies = [
"syn",
]
[[package]]
name = "tokio-native-tls"
version = "0.3.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "bbae76ab933c85776efabc971569dd6119c580d8f5d448769dec1764bf796ef2"
dependencies = [
"native-tls",
"tokio",
]
[[package]]
name = "tokio-util"
version = "0.7.14"
@@ -1728,6 +1972,12 @@ dependencies = [
"getrandom 0.3.2",
]
[[package]]
name = "vcpkg"
version = "0.2.15"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "accd4ea62f7bb7a82fe23066fb0957d48ef677f6eeb8215f372f52e48bb32426"
[[package]]
name = "want"
version = "0.3.1"
@@ -1778,6 +2028,19 @@ dependencies = [
"wasm-bindgen-shared",
]
[[package]]
name = "wasm-bindgen-futures"
version = "0.4.50"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "555d470ec0bc3bb57890405e5d4322cc9ea83cebb085523ced7be4144dac1e61"
dependencies = [
"cfg-if",
"js-sys",
"once_cell",
"wasm-bindgen",
"web-sys",
]
[[package]]
name = "wasm-bindgen-macro"
version = "0.2.100"
@@ -1810,6 +2073,16 @@ dependencies = [
"unicode-ident",
]
[[package]]
name = "web-sys"
version = "0.3.77"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "33b6dd2ef9186f1f2072e409e99cd22a975331a6b3591b12c764e0e55c60d5d2"
dependencies = [
"js-sys",
"wasm-bindgen",
]
[[package]]
name = "which"
version = "4.4.2"
@@ -2007,6 +2280,16 @@ version = "0.52.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec"
[[package]]
name = "winreg"
version = "0.50.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "524e57b2c537c0f9b1e69f1965311ec12182b4122e45035b1508cd24d2adadb1"
dependencies = [
"cfg-if",
"windows-sys 0.48.0",
]
[[package]]
name = "wit-bindgen-rt"
version = "0.39.0"
@@ -2050,6 +2333,7 @@ dependencies = [
"ratatui",
"rayon",
"regex",
"reqwest",
"serde",
"serde_json",
"serde_yaml",

View File

@@ -38,6 +38,7 @@ rayon = "1.7.0"
num_cpus = "1.16.0"
regex = "1.9"
lazy_static = "1.4"
reqwest = { version = "0.11", features = ["json"] }
[profile.release]
codegen-units = 1

View File

@@ -22,6 +22,7 @@ WRKFLW is a powerful command-line tool for validating and executing GitHub Actio
- **Special Action Handling**: Native handling for commonly used actions like `actions/checkout`
- **Output Capturing**: View logs, step outputs, and execution details
- **Parallel Job Execution**: Runs independent jobs in parallel for faster workflow execution
- **Trigger Workflows Remotely**: Manually trigger workflow runs on GitHub
## Installation
@@ -101,6 +102,13 @@ wrkflw tui path/to/workflow.yml
wrkflw tui --emulate
```
### Triggering Workflows Remotely
```bash
# Trigger a workflow remotely on GitHub
wrkflw trigger workflow-name --branch main --input key1=value1 --input key2=value2
```
## TUI Controls
The terminal user interface provides an interactive way to manage workflows:
@@ -216,3 +224,33 @@ WRKFLW automatically cleans up any Docker containers created during workflow exe
## License
This project is licensed under the MIT License - see the LICENSE file for details.
## Remote Workflow Triggering
The new `trigger` command lets you manually trigger workflow runs on GitHub. Requirements:
1. You need a GitHub token with appropriate permissions. Set it in the `GITHUB_TOKEN` environment variable:
```bash
export GITHUB_TOKEN=ghp_your_token_here
```
2. The workflow must have the `workflow_dispatch` trigger defined:
```yaml
on:
workflow_dispatch:
inputs:
# Optional inputs can be defined here
```
Examples:
```bash
# Trigger a workflow using the default branch
wrkflw trigger build
# Trigger on a specific branch
wrkflw trigger deploy --branch production
# Trigger with input parameters
wrkflw trigger release --input version=1.0.0 --input draft=false
```

183
src/github.rs Normal file
View File

@@ -0,0 +1,183 @@
use serde::Serialize;
use std::path::Path;
use thiserror::Error;
use reqwest::{Client, header};
use std::fs;
use std::process::Command;
use std::collections::HashMap;
use regex::Regex;
#[derive(Error, Debug)]
pub enum GithubError {
#[error("HTTP error: {0}")]
RequestError(#[from] reqwest::Error),
#[error("IO error: {0}")]
IoError(#[from] std::io::Error),
#[error("Failed to parse Git repository URL: {0}")]
GitParseError(String),
#[error("Failed to extract repository info: {0}")]
RepoInfoError(String),
#[error("GitHub token not found. Please set GITHUB_TOKEN environment variable")]
TokenNotFound,
#[error("Failed to parse workflow file: {0}")]
WorkflowParseError(String),
#[error("API error: {status} - {message}")]
ApiError { status: u16, message: String },
}
#[derive(Debug, Serialize)]
struct WorkflowDispatchPayload {
#[serde(rename = "ref")]
reference: String,
inputs: Option<HashMap<String, String>>,
}
/// Information about a GitHub repository
#[derive(Debug, Clone)]
pub struct RepoInfo {
pub owner: String,
pub repo: String,
pub default_branch: String,
}
/// Extract repository information from the current git repository
pub fn get_repo_info() -> Result<RepoInfo, GithubError> {
// Get the remote URL
let output = Command::new("git")
.args(["remote", "get-url", "origin"])
.output()?;
if !output.status.success() {
return Err(GithubError::GitParseError(
"Failed to get git remote URL".to_string(),
));
}
let url = String::from_utf8_lossy(&output.stdout).trim().to_string();
// Extract owner and repo from the URL using regex
let re = Regex::new(r"(?:https://github\.com/|git@github\.com:)([^/]+)/([^/.]+)(?:\.git)?").unwrap();
let captures = re.captures(&url).ok_or_else(|| {
GithubError::GitParseError(format!("Could not parse GitHub URL: {}", url))
})?;
let owner = captures.get(1).unwrap().as_str().to_string();
let repo = captures.get(2).unwrap().as_str().to_string();
// Get the default branch
let branch_output = Command::new("git")
.args(["rev-parse", "--abbrev-ref", "HEAD"])
.output()?;
if !branch_output.status.success() {
return Err(GithubError::GitParseError(
"Failed to get current branch".to_string(),
));
}
let default_branch = String::from_utf8_lossy(&branch_output.stdout).trim().to_string();
Ok(RepoInfo {
owner,
repo,
default_branch,
})
}
/// Get the list of available workflows in the repository
pub async fn list_workflows(_repo_info: &RepoInfo) -> Result<Vec<String>, GithubError> {
let workflows_dir = Path::new(".github/workflows");
if !workflows_dir.exists() {
return Err(GithubError::IoError(
std::io::Error::new(std::io::ErrorKind::NotFound, "Workflows directory not found")
));
}
let mut workflow_names = Vec::new();
for entry in fs::read_dir(workflows_dir)? {
let entry = entry?;
let path = entry.path();
if path.is_file() && path.extension().map_or(false, |ext| ext == "yml" || ext == "yaml") {
if let Some(file_name) = path.file_stem() {
if let Some(name) = file_name.to_str() {
workflow_names.push(name.to_string());
}
}
}
}
Ok(workflow_names)
}
/// Trigger a workflow on GitHub
pub async fn trigger_workflow(
workflow_name: &str,
branch: Option<&str>,
inputs: Option<HashMap<String, String>>,
) -> Result<(), GithubError> {
// Get GitHub token from environment
let token = std::env::var("GITHUB_TOKEN")
.map_err(|_| GithubError::TokenNotFound)?;
// Get repository information
let repo_info = get_repo_info()?;
// Create HTTP client with GitHub token
let mut headers = header::HeaderMap::new();
headers.insert(
header::ACCEPT,
header::HeaderValue::from_static("application/vnd.github.v3+json"),
);
headers.insert(
header::USER_AGENT,
header::HeaderValue::from_static("wrkflw-cli"),
);
let client = Client::builder()
.default_headers(headers)
.build()?;
// Prepare the request payload
let branch_ref = branch.unwrap_or(&repo_info.default_branch);
let payload = WorkflowDispatchPayload {
reference: branch_ref.to_string(),
inputs,
};
// Send the workflow_dispatch event
let url = format!(
"https://api.github.com/repos/{}/{}/actions/workflows/{}.yml/dispatches",
repo_info.owner, repo_info.repo, workflow_name
);
let response = client
.post(&url)
.bearer_auth(token)
.json(&payload)
.send()
.await?;
if !response.status().is_success() {
let status = response.status().as_u16();
let error_message = response.text().await.unwrap_or_else(|_| {
format!("Unknown error (HTTP {})", status)
});
return Err(GithubError::ApiError {
status,
message: error_message,
});
}
Ok(())
}

View File

@@ -1,5 +1,6 @@
mod evaluator;
mod executor;
mod github;
mod logging;
mod matrix;
mod models;
@@ -13,6 +14,7 @@ mod matrix_test;
use bollard::Docker;
use clap::{Parser, Subcommand};
use std::path::PathBuf;
use std::collections::HashMap;
#[derive(Debug, Parser)]
#[command(
@@ -56,6 +58,29 @@ enum Commands {
#[arg(short, long)]
emulate: bool,
},
/// Trigger a GitHub workflow remotely
Trigger {
/// Name of the workflow file (without .yml extension)
workflow: String,
/// Branch to run the workflow on
#[arg(short, long)]
branch: Option<String>,
/// Key-value inputs for the workflow in format key=value
#[arg(short, long, value_parser = parse_key_val)]
input: Option<Vec<(String, String)>>,
},
/// List available workflows
List,
}
// Parser function for key-value pairs
fn parse_key_val(s: &str) -> Result<(String, String), String> {
let pos = s.find('=').ok_or_else(|| format!("Invalid key=value: {}", s))?;
Ok((s[..pos].to_string(), s[pos + 1..].to_string()))
}
async fn cleanup_on_exit() {
@@ -149,6 +174,64 @@ async fn main() {
}
}
Some(Commands::Trigger { workflow, branch, input }) => {
let inputs = input.as_ref().map(|kv_pairs| {
kv_pairs.iter().cloned().collect::<HashMap<String, String>>()
});
match github::trigger_workflow(workflow, branch.as_deref(), inputs.clone()).await {
Ok(_) => {
println!("Successfully triggered workflow '{}' on GitHub", workflow);
if let Some(branch_name) = branch {
println!("Branch: {}", branch_name);
} else {
println!("Branch: default branch");
}
if let Some(workflow_inputs) = &inputs {
if !workflow_inputs.is_empty() {
println!("Inputs:");
for (key, value) in workflow_inputs {
println!(" {}: {}", key, value);
}
}
}
}
Err(e) => {
eprintln!("Error triggering workflow: {}", e);
std::process::exit(1);
}
}
}
Some(Commands::List) => {
match github::get_repo_info() {
Ok(repo_info) => {
match github::list_workflows(&repo_info).await {
Ok(workflows) => {
if workflows.is_empty() {
println!("No workflows found in the .github/workflows directory");
} else {
println!("Available workflows:");
for workflow in workflows {
println!(" {}", workflow);
}
println!("\nTrigger a workflow with: wrkflw trigger <workflow> [options]");
}
}
Err(e) => {
eprintln!("Error listing workflows: {}", e);
std::process::exit(1);
}
}
}
Err(e) => {
eprintln!("Error getting repository info: {}", e);
std::process::exit(1);
}
}
}
None => {
// Default to TUI interface if no subcommand
match ui::run_wrkflw_tui(