Skip to content

Commit

Permalink
meta: release v1.6.0 (ran on Linux) (#270)
Browse files Browse the repository at this point in the history
* meta: release v1.6.0

* README: update release steps
  • Loading branch information
strohel authored Jun 14, 2023
1 parent 0998593 commit 8d058c8
Show file tree
Hide file tree
Showing 21 changed files with 1,546 additions and 433 deletions.
10 changes: 5 additions & 5 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,10 +216,10 @@ brew install tonarino/innernet/innernet

```sh
# to install innernet:
cargo install --git https://github.com/tonarino/innernet --tag v1.5.5 client
cargo install --git https://github.com/tonarino/innernet --tag v1.6.0 client

# to install innernet-server:
cargo install --git https://github.com/tonarino/innernet --tag v1.5.5 server
cargo install --git https://github.com/tonarino/innernet --tag v1.6.0 server
```

Note that you'll be responsible for updating manually.
Expand Down Expand Up @@ -255,6 +255,8 @@ The resulting binary will be located at `./target/release/innernet`

### Releases

1. Run `cargo release [--dry-run] [minor|major|patch|...]` to automatically bump the crates appropriately.
2. Create a new git tag (ex. `v0.6.0`).
3. Push (with tags) to the repo.
Please run the release script from a Linux machine: generated shell completions depend on available wireguard backends and Mac doesn't support the `kernel` backend.

1. Fetch and check-out the `main` branch.
2. Run `./release.sh [patch|major|minor|rc]`
3. Push the `main` branch and the created tag to the repo.
2 changes: 1 addition & 1 deletion client/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ name = "client"
publish = false
readme = "README.md"
repository = "https://github.com/tonarino/innernet"
version = "1.5.5"
version = "1.6.0"

[[bin]]
name = "innernet"
Expand Down
70 changes: 33 additions & 37 deletions doc/innernet-server.8
Original file line number Diff line number Diff line change
@@ -1,48 +1,19 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.2.
.TH INNERNET-SERVER "8" "September 2022" "innernet-server 1.5.5" "System Administration Utilities"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH INNERNET-SERVER "8" "June 2023" "innernet-server 1.6.0" "System Administration Utilities"
.SH NAME
innernet-server \- manual page for innernet-server 1.5.5
innernet-server \- manual page for innernet-server 1.6.0
.SH SYNOPSIS
.B innernet-server
[\fI\,OPTIONS\/\fR] \fI\,<COMMAND>\/\fR
.SH DESCRIPTION
innernet\-server 1.5.5
Jake McGinty <[email protected]>
A server to coordinate innernet networks.
.SS "USAGE:"
.IP
innernet\-server [OPTIONS] <SUBCOMMAND>
.SS "OPTIONS:"
.TP
\fB\-c\fR, \fB\-\-config\-dir\fR <CONFIG_DIR>
[default: /etc/innernet\-server]
.TP
\fB\-d\fR, \fB\-\-data\-dir\fR <DATA_DIR>
[default: /var/lib/innernet\-server]
.TP
\fB\-\-no\-routing\fR
Whether the routing should be done by innernet or is done by an
external tool like e.g. babeld
.TP
\fB\-\-backend\fR <BACKEND>
Specify a WireGuard backend to use. If not set, innernet will
auto\-select based on availability [default: kernel] [possible
values: kernel, userspace]
.TP
\fB\-\-mtu\fR <MTU>
Specify the desired MTU for your interface (default: 1280)
.TP
\fB\-h\fR, \fB\-\-help\fR
Print help information
.TP
\fB\-V\fR, \fB\-\-version\fR
Print version information
.SS "SUBCOMMANDS:"
.SS "Commands:"
.TP
new
Create a new network
.TP
uninstall
Permanently uninstall a created network, rendering it unusable. Use with
.IP
care
Permanently uninstall a created network, rendering it unusable. Use with care
.TP
serve
Serve the coordinating server for an existing network
Expand Down Expand Up @@ -70,3 +41,28 @@ Generate shell completion scripts
.TP
help
Print this message or the help of the given subcommand(s)
.SH OPTIONS
.TP
\fB\-c\fR, \fB\-\-config\-dir\fR <CONFIG_DIR>
[default: /etc/innernet\-server]
.TP
\fB\-d\fR, \fB\-\-data\-dir\fR <DATA_DIR>
[default: /var/lib/innernet\-server]
.TP
\fB\-\-no\-routing\fR
Whether the routing should be done by innernet or is done by an
external tool like e.g. babeld
.TP
\fB\-\-backend\fR <BACKEND>
Specify a WireGuard backend to use. If not set, innernet will
auto\-select based on availability [default: kernel] [possible
values: kernel, userspace]
.TP
\fB\-\-mtu\fR <MTU>
Specify the desired MTU for your interface (default: 1280)
.TP
\fB\-h\fR, \fB\-\-help\fR
Print help
.TP
\fB\-V\fR, \fB\-\-version\fR
Print version
Binary file modified doc/innernet-server.8.gz
Binary file not shown.
Loading

0 comments on commit 8d058c8

Please sign in to comment.