Skip to content
This repository has been archived by the owner on Oct 11, 2024. It is now read-only.

Commit

Permalink
chore: basic CI
Browse files Browse the repository at this point in the history
  • Loading branch information
akorchyn committed Sep 9, 2024
1 parent b440b9e commit c7889dc
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 1 deletion.
62 changes: 62 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: Test & Release

on:
push:
branches: [ main ]
pull_request:

env:
CARGO_TERM_COLOR: always
RUSTFLAGS: '-D warnings'
CARGO_INCREMENTAL: 0
RUST_BACKTRACE: short

jobs:
clippy:
runs-on: ubuntu-20.04

steps:
- uses: actions/checkout@v4
- name: Run clippy
run: cargo clippy --all-targets -- -D clippy::all -D clippy::nursery

cargo-fmt:
runs-on: ubuntu-20.04

steps:
- uses: actions/checkout@v4
- name: Run cargo fmt
run: cargo fmt --check

# there're sometimes warnings, which signal, that the generated doc
# won't look as expected, when rendered, and sometimes errors, which will prevent doc from being
# generated at release time altogether.
cargo-doc:
runs-on: ubuntu-20.04

steps:
- uses: actions/checkout@v4
- name: run cargo doc
run: RUSTDOCFLAGS="-D warnings" cargo doc

test:
needs: cargo-fmt
strategy:
matrix:
platform: [ubuntu-latest, macos-latest, windows-latest]
toolchain: [stable]
runs-on: ${{ matrix.platform }}

steps:
- uses: actions/checkout@v2
- name: "${{ matrix.toolchain }}"
uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: ${{ matrix.toolchain }}
default: true
- uses: Swatinem/rust-cache@v1
- name: Check with stable features
run: cargo check --verbose
- name: Run tests with unstable features
run: cargo test --verbose
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Currently, the library provides:
The library is already usable and might be used for rapid prototyping, it lacks some points to make it production-ready:
- [ ] documentation + examples
- [ ] integration tests for all API calls
- [ ] CI/CD
- [x] CI
- [x] anyhow -> thiserror
- [x] ledger is blocking and it's not good in the async runtime
- [ ] secure keychain is not that straightforward to use
Expand Down

0 comments on commit c7889dc

Please sign in to comment.