A rust client for the Evergreen REST API.
- evg-api-rs
A rust library for interacting with the Evergreen REST API.
If you have a question about evg-api-rs, please mention @dag-on-call in slack channel #evergreen-users, or email us at dev-prod-dag@mongodb.com.
Create a DAG ticket in Jira.
Please include as much information as possible. This can help avoid long information-gathering threads.
Please include the following:
- Motivation for Request: Why is this change being requested? (This help us understand the priority and urgency of the request)
- Context: Is there any background information we should be aware of for this request?
- Description: What would you like investigated or changed?
To install, include "evg-api-rs" in your projects Cargo.toml dependencies.
A simple example:
use std::path::Path;
use evg_api_rs::EvgClient;
let evg_auth_file = Path::from("path/to/evergreen.yml");
let evg_client = EvgClient::from_file(&evg_auth_file).expect("Cannot find evergreen auth file")
let task = evg_client.get_task(task_id).unwrap();
println!("Found task: {}", task.display_name);
For a more complex example of how shrub can be used see the mongo-task-generator.
After cloning the repository, simply run cargo build
to download and build the project.
cargo fmt
cargo clippy
cargo test
This project uses semver for versioning.
Please include a description what is added for each new version in CHANGELOG.md
.
Code reviews are required on all changes and are done via Github Pull Requests.
Deployment should be done with the cargo publish command.