Skip to content

Update usage.md

Update usage.md #80

Workflow file for this run

name: CI
on:
push:
branches: [main, master]
tags: ['v*']
pull_request:
branches: [main, master]
env:
CARGO_TERM_COLOR: always
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions-rust-lang/setup-rust-toolchain@v1
with:
components: clippy, rustfmt
- name: Check formatting
run: cargo fmt --check
- name: Clippy
run: cargo clippy -- -D warnings
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions-rust-lang/setup-rust-toolchain@v1
- name: Build
run: cargo build --verbose
- name: Test
run: cargo test --verbose
build:
strategy:
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
- uses: actions-rust-lang/setup-rust-toolchain@v1
- name: Build release
run: cargo build --release --verbose
- name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: torot-${{ matrix.os }}
path: target/release/torot${{ runner.os == 'Windows' && '.exe' || '' }}
release:
if: startsWith(github.ref, 'refs/tags/v')
needs: [lint, test, build]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions-rust-lang/setup-rust-toolchain@v1
- name: Build release
run: cargo build --release
- name: Create release archive
run: |
mkdir -p dist
cp target/release/torot dist/
cp config/default-config.json dist/torot-config.json
cp config/report-template.md dist/
cp README.md dist/
cp LICENSE dist/
cd dist && tar czf ../torot-$(uname -s)-$(uname -m).tar.gz *
- name: Create GitHub Release
uses: softprops/action-gh-release@v2
with:
files: torot-*.tar.gz
generate_release_notes: true