/
index.html
86 lines (77 loc) · 11.9 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `ci_info` crate."><meta name="keywords" content="rust, rustlang, rust-lang, ci_info"><title>ci_info - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../ci_info/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate ci_info</p><div class='block version'><p>Version 0.11.0</p></div><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all ci_info's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'ci_info', ty: 'mod', relpath: '../'};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><span class="help-button">?</span>
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/ci_info/lib.rs.html#1-322' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>ci_info</a></span></h1><div class='docblock'><h1 id="ci_info" class="section-header"><a href="#ci_info">ci_info</a></h1>
<p>Provides current CI environment information.</p>
<p>This library main goal is to provide development/build tools such as <a href="https://sagiegurari.github.io/cargo-make/">cargo-make</a> the needed information on the current CI environment.<br>
The code is based on the <a href="https://github.com/watson/ci-info">ci-info</a> npm module.</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1><h2 id="get-ci-environment-information" class="section-header"><a href="#get-ci-environment-information">Get CI environment information</a></h2>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">fn</span> <span class="ident">main</span>() {
<span class="comment">// Just check if a CI environment is detected.</span>
<span class="kw">let</span> <span class="ident">ci</span> <span class="op">=</span> <span class="ident">ci_info</span>::<span class="ident">is_ci</span>();
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Is CI: {}"</span>, <span class="ident">ci</span>);
<span class="comment">// Get CI environment information</span>
<span class="kw">let</span> <span class="ident">info</span> <span class="op">=</span> <span class="ident">ci_info</span>::<span class="ident">get</span>();
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Is CI: {}"</span>, <span class="ident">info</span>.<span class="ident">ci</span>);
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">vendor</span>) <span class="op">=</span> <span class="ident">info</span>.<span class="ident">vendor</span> {
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Vendor: {:#?}"</span>, <span class="ident">vendor</span>);
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Name: {:#?}"</span>, <span class="ident">info</span>.<span class="ident">name</span>.<span class="ident">unwrap</span>());
}
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">pr</span>) <span class="op">=</span> <span class="ident">info</span>.<span class="ident">pr</span> {
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Is PR: {:#?}"</span>, <span class="ident">pr</span>);
}
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">branch_name</span>) <span class="op">=</span> <span class="ident">info</span>.<span class="ident">branch_name</span> {
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Branch Name: {:#?}"</span>, <span class="ident">branch_name</span>);
}
}</pre></div>
<h2 id="check-if-a-ci-environment-is-detected" class="section-header"><a href="#check-if-a-ci-environment-is-detected">Check if a CI environment is detected</a></h2>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">fn</span> <span class="ident">main</span>() {
<span class="kw">let</span> <span class="ident">ci</span> <span class="op">=</span> <span class="ident">ci_info</span>::<span class="ident">is_ci</span>();
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Is CI: {}"</span>, <span class="ident">ci</span>);
}</pre></div>
<h2 id="mocking-ci-environment" class="section-header"><a href="#mocking-ci-environment">Mocking CI environment</a></h2>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">ci_info</span>::<span class="ident">types</span>::{<span class="ident">CiInfo</span>, <span class="ident">Vendor</span>};
<span class="kw">fn</span> <span class="ident">main</span>() {
<span class="comment">// create the CI info manually</span>
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">mock_info</span> <span class="op">=</span> <span class="ident">CiInfo</span>::<span class="ident">new</span>();
<span class="ident">mock_info</span>.<span class="ident">vendor</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">Vendor</span>::<span class="ident">TravisCI</span>);
<span class="ident">mock_info</span>.<span class="ident">ci</span> <span class="op">=</span> <span class="bool-val">true</span>;
<span class="ident">mock_info</span>.<span class="ident">pr</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="bool-val">true</span>);
<span class="ident">mock_info</span>.<span class="ident">branch_name</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="string">"dev_branch"</span>.<span class="ident">to_string</span>());
<span class="comment">// mock environment</span>
<span class="ident">ci_info</span>::<span class="ident">mock_ci</span>(<span class="kw-2">&</span><span class="ident">mock_info</span>);
<span class="kw">let</span> <span class="ident">info</span> <span class="op">=</span> <span class="ident">ci_info</span>::<span class="ident">get</span>();
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">info</span>.<span class="ident">ci</span>);
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">info</span>.<span class="ident">pr</span>.<span class="ident">unwrap</span>());
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">info</span>.<span class="ident">vendor</span>.<span class="ident">unwrap</span>(), <span class="ident">Vendor</span>::<span class="ident">TravisCI</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">info</span>.<span class="ident">name</span>.<span class="ident">unwrap</span>(), <span class="string">"Travis CI"</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">info</span>.<span class="ident">branch_name</span>.<span class="ident">unwrap</span>(), <span class="string">"dev_branch"</span>);
<span class="comment">// clear CI environment</span>
<span class="ident">mock_info</span> <span class="op">=</span> <span class="ident">CiInfo</span>::<span class="ident">new</span>();
<span class="ident">ci_info</span>::<span class="ident">mock_ci</span>(<span class="kw-2">&</span><span class="ident">mock_info</span>);
<span class="kw">let</span> <span class="ident">info</span> <span class="op">=</span> <span class="ident">ci_info</span>::<span class="ident">get</span>();
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span><span class="ident">info</span>.<span class="ident">ci</span>);
}</pre></div>
<h1 id="installation" class="section-header"><a href="#installation">Installation</a></h1>
<p>In order to use this library, just add it as a dependency:</p>
<pre><code class="language-ini">[dependencies]
ci_info = "*"
</code></pre>
<p>There is optional <code>serde</code> support that can be enabled via the <code>serde-1</code> feature:</p>
<pre><code class="language-ini">[dependencies]
ci_info = { version = "*", features = ["serde-1"] }
</code></pre>
<h1 id="contributing" class="section-header"><a href="#contributing">Contributing</a></h1>
<p>See <a href="https://github.com/sagiegurari/ci_info/blob/master/.github/CONTRIBUTING.md">contributing guide</a></p>
<h1 id="license" class="section-header"><a href="#license">License</a></h1>
<p>Developed by Sagie Gur-Ari and licensed under the
<a href="https://github.com/sagiegurari/ci_info/blob/master/LICENSE">Apache 2</a> open source license.</p>
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table><tr class='module-item'><td><a class="mod" href="types/index.html" title='ci_info::types mod'>types</a></td><td class='docblock-short'><p>types</p>
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table><tr class='module-item'><td><a class="fn" href="fn.get.html" title='ci_info::get fn'>get</a></td><td class='docblock-short'><p>Loads and returns the CI info of the current environment.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.is_ci.html" title='ci_info::is_ci fn'>is_ci</a></td><td class='docblock-short'><p>Returns true if a CI environment is detected.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.mock_ci.html" title='ci_info::mock_ci fn'>mock_ci</a></td><td class='docblock-short'><p>This function will modify the current environment variables to mock the
requested CI vendor.</p>
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "ci_info";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>