From d2fa7fbaf17667f2f4c38d8525860ee30e04b586 Mon Sep 17 00:00:00 2001 From: Sean Bowe Date: Tue, 20 Oct 2020 15:12:37 -0600 Subject: [PATCH] Initial commit --- .github/workflows/ci.yml | 64 ++++++++++++++++++++++++++++++++++++++++ .gitignore | 4 +++ Cargo.toml | 19 ++++++++++++ katex-header.html | 15 ++++++++++ src/lib.rs | 6 ++++ 5 files changed, 108 insertions(+) create mode 100644 .github/workflows/ci.yml create mode 100644 .gitignore create mode 100644 Cargo.toml create mode 100644 katex-header.html create mode 100644 src/lib.rs diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 00000000..4bc6019b --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,64 @@ +name: CI checks + +on: [push, pull_request] + +jobs: + + lint: + name: Lint + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v1 + - uses: actions-rs/toolchain@v1 + with: + toolchain: 1.45.2 + override: true + + # Build the code before running cargo fmt + - name: cargo build + uses: actions-rs/cargo@v1 + with: + command: build + args: --all + + # Ensure all code has been formatted with rustfmt + - run: rustup component add rustfmt + - name: Check formatting + uses: actions-rs/cargo@v1 + with: + command: fmt + args: --all -- --check --color always + + # Build benchmarks to prevent bitrot + - name: Build benchmarks + uses: actions-rs/cargo@v1 + with: + command: build + args: --all --benches + + build_and_test: + name: Test on ${{ matrix.os }} + runs-on: ${{ matrix.os }} + strategy: + matrix: + # We don't need to test across multiple platforms yet + # os: [ubuntu-latest, windows-latest, macOS-latest] + os: [ubuntu-latest] + + steps: + - uses: actions/checkout@v1 + - uses: actions-rs/toolchain@v1 + with: + toolchain: 1.45.2 + override: true + - name: Build tests + uses: actions-rs/cargo@v1 + with: + command: build + args: --verbose --release --all --tests --all-features + - name: Run tests + uses: actions-rs/cargo@v1 + with: + command: test + args: --verbose --release --all diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..173b9514 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +/target +**/*.rs.bk +Cargo.lock +.vscode diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 00000000..0b474f75 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,19 @@ +[package] +name = "pollard" +version = "0.0.0" +authors = [ + "Sean Bowe ", +] +edition = "2018" +description = """ +TBD +""" +license = "MIT" +repository = "https://github.com/zcash/pollard" +documentation = "https://docs.rs/pollard" +readme = "README.md" + +# publish = false + +[package.metadata.docs.rs] +rustdoc-args = [ "--html-in-header", "katex-header.html" ] diff --git a/katex-header.html b/katex-header.html new file mode 100644 index 00000000..98e85904 --- /dev/null +++ b/katex-header.html @@ -0,0 +1,15 @@ + + + + \ No newline at end of file diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 00000000..51bd14dc --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,6 @@ +//! # pollard + +#![deny(intra_doc_link_resolution_failure)] +#![deny(missing_debug_implementations)] +#![deny(missing_docs)] +#![deny(unsafe_code)]