vergen 0.0.16

Generate version related functions
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

# vergen
Includes 3 functions for use in version strings in ```lib.rs/main.rs``` at compile time via a custom cargo build script.

Note:  This currently only works for projects using git building on Linux or msys2.  I haven't tested on Mac OS/X, but it will work if the date command exists.  I plan to expand the functionality to additional platforms eventually.

```rust
pub fn now() -> &'static str {
   // Output of 'date --rc-3339=ns'
}

pub fn short_now() -> &'static str {
   // Output of 'date --rc-3339=date'
}

pub fn sha() -> &'static str {
   // Output of 'git rev-parse HEAD'
}

pub fn short_sha() -> &'static str {
   // Output of 'git rev-parse --short HEAD'
}

pub fn commit_date() -> &'static str {
   // Output of 'git log --pretty=format:"%ad" -n1 --date=short'
}

pub fn target() -> &'static str {
   // env::var("TARGET")
}

pub fn semver() -> &'static str {
   // output of 'git describe'
   // this works best if you tag your releases 'vX.X.X'
   // and create a new tag on master after a release 'vX.X.Y-pre'
}
```

## Status
[![Build Status](https://travis-ci.org/rustyhorde/vergen.svg?branch=0.0.16)](https://travis-ci.org/rustyhorde/vergen)

## Basic Usage
#### Cargo.toml
```toml
[package]
#
build = "build.rs"
#
[build-dependencies]
vergen = "*"
```
#### build.rs
```rust
use vergen::vergen;

fn main() {
    vergen();
}
```
#### lib.rs/main.rs
```rust
include!(concat!(env!("OUT_DIR"), "/version.rs"));

// The following is an exmaple.  You could use now(), sha(), and semver() however you want.
fn version() -> String {
    format!("{} {} {}", now(), sha(), semver())
    // 2015-02-11 15:35:30.991638113-05:00 b8acdc17bbf0d9928f08b15cba6d3b659770a624 rh v0.0.1-pre-21-gb8acdc1
}
```