upversion 0.1.0

provides you to notify your clients when new version released
Documentation 
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

[![Build](https://github.com/rusty-ferris-club/upversion/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/rusty-ferris-club/upversion/actions/workflows/ci.yml)
<p align="center">
</p>
<p align="center">
<b>:label: keep your client up to date</b>
<br/>
<b>:see_no_evil: Run in the background</b>
<br/>
<b>:hourglass: Limit background task</b>
<br/>
<hr/>
</p>

# upversion

`upversion` provides you to notify your clients when new version released and show the latest download link.

```sh
$ ./test-tool
==> 🙆‍♂️ Newer <tool-name> version available: <user-version> (currently running: 0.5.2) | Link: <dynamic-link>
```

## How it works
`upversion` running as a background process which not affect your tool performance.
1. you can choose when present the newer version
2. you can skip message notification if your proccess finished before `upversion`

## Usage
Add this to Cargo.toml:
```toml
[dependencies]
upversion = { version = "0.1" }
```

## Vendor
* GitHub releases
* Custom RestAPI


## Github Example:
```rs
use anyhow::Result;
use upversion::vendors::GitHubVendor;
use upversion::CheckVersion;

fn main() -> Result<()> {
    let github = Box::new(GitHubVendor::new("kaplanelad", "shellfirm"));
    let timeout = 2; // in seconds
    let version_context = CheckVersion::new("app-name", github, timeout)?;

    // run command execute upversion check in the background and finish immediately.
    version_context.run("0.0.1")?;

    // sleep here simulator your program
    std::thread::sleep(std::time::Duration::from_secs(3));

    // at the end of your program, you can call printstd to print to the STDOUT a alert information for a new version which released
    version_context.printstd();
    Ok(())
}
```

## Custom API:
If you manage your program version internally, you allow to serve the new version with your custom logic via rest API, and `upversion` will query your endpoint.
```rs
use anyhow::Result;
use upversion::vendors::Api;
use upversion::CheckVersion;

fn main() -> Result<()> {
    // server json response: { "version": "", "release_downloads": [] }
    let api = Box::new(Api::new("http://127.0.0.1:3000"));
    let timeout = 2; // in seconds
    let version_context = CheckVersion::new("app-name", api, timeout)?;

    // run command execute upversion check in the background and finish immediately.
    version_context.run("0.0.1")?;

    // sleep here simulator your program
    std::thread::sleep(std::time::Duration::from_secs(3));

    // at the end of your program, you can call printstd to print to the STDOUT a alert information for a new version which released
    version_context.printstd();
    Ok(())
}
```

### More example
You can find more example [here](./examples/), or run via cargo `cargo run --example`


## Customize Template
Customize alert message with your owned template
```rs
    const CUSTOM_TEMPLATE: &str = r#"==> [CUSTOM_TEMPLATE]:: 🙆‍♂️ Newer {{ app_name }} version available: {{ new_version }} (currently running: {{ current_version }}) {% if download_link %}| Link: {{ download_link }} {% endif %}"#;
    ... 
    version_context.printstd_with_template(CUSTOM_TEMPLATE);
```


# Thanks
To all [Contributors](https://github.com/rusty-ferris-club/upversion/graphs/contributors) - you make this happen, thanks!

# Copyright
Copyright (c) 2022 [@kaplanelad](https://github.com/kaplanelad). See [LICENSE](LICENSE.txt) for further details.