/gouqi

a rust interface for jira

Primary LanguageRustMIT LicenseMIT

gouqi

Software License Released API docs Rust codecov

a rust interface for jira

Forked from goji https://github.com/softprops/goji

install

Add the following to your Cargo.toml file

[dependencies]
gouqi = "*"

usage

Please browse the examples directory in this repo for some example applications.

Basic usage requires a jira host, and a flavor of jira::Credentials for authorization.

Current support api support is limited to search and issue transitioning.

extern crate gouqi;

use gouqi::{Credentials, Jira};
use std::env;
use tracing::error;

fn main() { 
    if let Ok(host) = env::var("JIRA_HOST") {
        let query = env::args().nth(1).unwrap_or("order by created DESC".to_owned());
        let jira = Jira::new(host, Credentials::Anonymous).expect("Error initializing Jira");

        match jira.search().iter(query, &Default::default()) {
            Ok(results) => {
                for issue in results {
                    println!("{:#?}", issue);
                }
            }
            Err(err) => panic!("{:#?}", err),
        }
    } else {
        error!("Missing environment variable JIRA_HOST!");
    }
}

Commiting a PR

Please make sure to run cargo fmt, cargo test and cargo clippy before committing. New code should contains tests. Commits to follow the Conventional Commits specification.

Changelog is generated using git cliff

cargo install git-cliff
git cliff -o --use-branch-tags

what's with the name

Jira's name is a shortened form of gojira, another name for godzilla. Goji is a play on that.

Goji (Chinese: 枸杞; pinyin: gǒuqǐ)

Doug Tangren (softprops) 2016-2018