diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml new file mode 100644 index 0000000..7165fb3 --- /dev/null +++ b/.github/workflows/rust.yml @@ -0,0 +1,53 @@ +name: Rust + +on: + push: + branches: [dev] + pull_request: + branches: [dev] + +env: + CARGO_TERM_COLOR: always + CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse + +jobs: + build_and_test: + if: ( ! github.event.pull_request.draft ) + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + + - name: Stable + uses: actions-rs/toolchain@v1 + with: + profile: minimal + toolchain: stable + - uses: Swatinem/rust-cache@v2.0.0 + + - name: "Build" + run: cargo build + + - name: "Test" + run: cargo test --lib --bins --tests --examples --workspace + + - name: "Check documentation" + env: + RUSTDOCFLAGS: -D warnings + run: cargo doc --no-deps --document-private-items --all-features --workspace --examples + + rustfmt: + name: Rustfmt + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + + - name: Nightly with rustfmt + uses: actions-rs/toolchain@v1 + with: + profile: minimal + toolchain: nightly + components: rustfmt + + - name: "Check formatting" + run: cargo +nightly fmt --check --all \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..34e09db --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +/target +.cargo-ok +.DS_Store + +Cargo.lock \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..ef88a6b --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..15aff1e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,36 @@ +# Contribution guidelines + +First off, thank you for contributing to tlsn-utils. + +If your contribution is not straightforward, please first discuss the change you +wish to make by creating a new issue. + +## Reporting issues + +Before reporting an issue on the +[issue tracker](https://github.com/tlsnotary/tlsn-utils/issues), +please check that it has not already been reported by searching for some related +keywords. + +## Pull requests + +Try to do one pull request per change. + +### Updating the changelog + +Update the changes you have made in +[CHANGELOG](CHANGELOG.md) +file under the **Unreleased** section. + +Add the changes of your pull request to one of the following subsections, +depending on the types of changes defined by +[Keep a changelog](https://keepachangelog.com/en/1.0.0/): + +- `Added` for new features. +- `Changed` for changes in existing functionality. +- `Deprecated` for soon-to-be removed features. +- `Removed` for now removed features. +- `Fixed` for any bug fixes. +- `Security` in case of vulnerabilities. + +If the required subsection does not exist yet under **Unreleased**, create it! \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..fff33a7 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +[![CI](https://github.com/tlsnotary/tlsn-utils/actions/workflows/rust.yml/badge.svg)](https://github.com/tlsnotary/tlsn-utils/actions) + +

+ +

+ +# TLSNotary Utils + +Utility functions which are used for the development of [TLSNotary](https://github.com/tlsnotary/tlsn) + +## ⚠️ Notice + +This project is currently under active development and should not be used in production. Expect bugs and regular major breaking changes. + +## License +All crates in this repository are licensed under either of + +- [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) +- [MIT license](http://opensource.org/licenses/MIT) + +at your option. + + +## Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in the work by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions. + +See [CONTRIBUTING.md](CONTRIBUTING.md). diff --git a/tlsn-banner.png b/tlsn-banner.png new file mode 100644 index 0000000..7ef31c6 Binary files /dev/null and b/tlsn-banner.png differ