Skip to content

Commit

Permalink
added github workflow and corrected readme format
Browse files Browse the repository at this point in the history
  • Loading branch information
sabify committed Jun 3, 2023
1 parent a58cd67 commit 40a95c0
Show file tree
Hide file tree
Showing 5 changed files with 136 additions and 5 deletions.
12 changes: 12 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
version: 2
updates:

- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"

- package-ecosystem: "cargo"
directory: "/"
schedule:
interval: "daily"
86 changes: 86 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
name: Build Releases
on:
push:
tags:
- v*.*.*

env:
CARGO_TERM_COLOR: always

jobs:
build-linux:
runs-on: ubuntu-20.04
env:
RUST_BACKTRACE: full
strategy:
matrix:
target:
- x86_64-unknown-linux-gnu
- x86_64-unknown-linux-musl
- i686-unknown-linux-gnu
- i686-unknown-linux-musl
- armv7-unknown-linux-gnueabihf
- armv7-unknown-linux-musleabihf
- arm-unknown-linux-gnueabihf
- arm-unknown-linux-musleabihf
- aarch64-unknown-linux-gnu
- aarch64-unknown-linux-musl
- mips-unknown-linux-gnu
- mips-unknown-linux-musl
- mipsel-unknown-linux-gnu
- mipsel-unknown-linux-musl

steps:
- uses: actions/checkout@v3
- uses: actions-rs/toolchain@v1
with:
toolchain: stable
target: ${{ matrix.target }}
override: true
- uses: actions-rs/cargo@v1
with:
use-cross: true
command: build
args: --release --target ${{ matrix.target }}
- name: Compress
run: |
cd target/${{ matrix.target }}/release
zip uki_${{ matrix.target }}.zip uki
- name: Upload Github Assets
uses: softprops/action-gh-release@v1
with:
files: target/${{ matrix.target }}/release/*.zip
prerelease: ${{ contains(github.ref, '-') }}

build-macos:
runs-on: macos-latest
env:
RUST_BACKTRACE: full
strategy:
matrix:
target:
- x86_64-apple-darwin
- aarch64-apple-darwin

steps:
- uses: actions/checkout@v3
- uses: actions-rs/toolchain@v1
with:
toolchain: stable
target: ${{ matrix.target }}
override: true
- uses: actions-rs/cargo@v1
with:
command: build
args: --release --target ${{ matrix.target }}
- name: Compress
run: |
cd target/${{ matrix.target }}/release
zip uki_${{ matrix.target }}.zip uki
- name: Upload Github Assets
uses: softprops/action-gh-release@v1
with:
files: target/${{ matrix.target }}/release/*.zip
prerelease: ${{ contains(github.ref, '-') }}
33 changes: 33 additions & 0 deletions .github/workflows/rust.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Rust

on: [push, pull_request]

env:
CARGO_TERM_COLOR: always

jobs:
build-linux:
runs-on: ubuntu-20.04

steps:
- uses: actions/checkout@v3
- uses: actions-rs/toolchain@v1
with:
toolchain: stable
- name: Run lint
run: cargo clippy --verbose --all-targets --all-features
- name: Build
run: cargo build --verbose

build-macos:
runs-on: macos-latest

steps:
- uses: actions/checkout@v3
- uses: actions-rs/toolchain@v1
with:
toolchain: stable
- name: Run lint
run: cargo clippy --verbose --verbose --all-targets --all-features
- name: Build
run: cargo build --verbose
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ edition = "2021"
authors = ["Saber Haj Rabiee"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/sabify/uki"
keywords = ["encryption", "udp", "network", "packet", "forwarder", "tunnel"]
keywords = ["encryption", "udp", "network", "forward", "tunnel"]
categories = ["network-programming"]
readme = "README.md"
description = """
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ Uki (pronounced `ookee`) is a fast, simple and cross-platform UDP packet forward

Here are some of the features of Uki:

Fast and reliable: Uki is designed to be fast and reliable, even when forwarding large amounts of data.
Simple to use: Uki is easy to use, even for users with no experience with packet forwarding.
Secure: Uki can encrypt all packets to protect your data from prying eyes.
Cross-Platform: Uki can be run anywhere that Rust compiler supports.
- Fast and reliable: Uki is designed to be fast and reliable, even when forwarding large amounts of data.
- Simple to use: Uki is easy to use, even for users with no experience with packet forwarding.
- Secure: Uki can encrypt all packets to protect your data from prying eyes.
- Cross-Platform: Uki can be run anywhere that Rust compiler supports.

# Usage

Expand Down

0 comments on commit 40a95c0

Please sign in to comment.