docs: prepare Readme and documentation for new release #943
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| on: | |
| push: | |
| branches: | |
| - master | |
| paths-ignore: | |
| - "**.md" | |
| - "!.github/workflows/*.yml" | |
| - "!rln/src/**" | |
| - "!rln/resources/**" | |
| - "!utils/src/**" | |
| pull_request: | |
| paths-ignore: | |
| - "**.md" | |
| - "!.github/workflows/*.yml" | |
| - "!rln/src/**" | |
| - "!rln/resources/**" | |
| - "!utils/src/**" | |
| name: Tests | |
| jobs: | |
| utils-test: | |
| strategy: | |
| matrix: | |
| platform: [ ubuntu-latest, macos-latest ] | |
| crate: [ utils ] | |
| runs-on: ${{ matrix.platform }} | |
| timeout-minutes: 60 | |
| name: test - ${{ matrix.crate }} - ${{ matrix.platform }} | |
| steps: | |
| - name: Checkout sources | |
| uses: actions/checkout@v3 | |
| - name: Install stable toolchain | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| profile: minimal | |
| toolchain: stable | |
| override: true | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: Install dependencies | |
| run: make installdeps | |
| - name: cargo-make test | |
| run: | | |
| cargo make test --release | |
| working-directory: ${{ matrix.crate }} | |
| rln-test: | |
| strategy: | |
| matrix: | |
| platform: [ ubuntu-latest, macos-latest ] | |
| crate: [ rln ] | |
| feature: [ "default", "arkzkey", "stateless" ] | |
| runs-on: ${{ matrix.platform }} | |
| timeout-minutes: 60 | |
| name: test - ${{ matrix.crate }} - ${{ matrix.platform }} - ${{ matrix.feature }} | |
| steps: | |
| - name: Checkout sources | |
| uses: actions/checkout@v3 | |
| - name: Install stable toolchain | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| profile: minimal | |
| toolchain: stable | |
| override: true | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: Install dependencies | |
| run: make installdeps | |
| - name: cargo-make test | |
| run: | | |
| if [ ${{ matrix.feature }} == default ]; then | |
| cargo make test --release | |
| else | |
| cargo make test_${{ matrix.feature }} --release | |
| fi | |
| working-directory: ${{ matrix.crate }} | |
| lint: | |
| strategy: | |
| matrix: | |
| # we run lint tests only on ubuntu | |
| platform: [ ubuntu-latest ] | |
| crate: [ rln, utils ] | |
| runs-on: ${{ matrix.platform }} | |
| timeout-minutes: 60 | |
| name: lint - ${{ matrix.crate }} - ${{ matrix.platform }} | |
| steps: | |
| - name: Checkout sources | |
| uses: actions/checkout@v3 | |
| - name: Install stable toolchain | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| profile: minimal | |
| toolchain: stable | |
| override: true | |
| components: rustfmt, clippy | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: Install Dependencies | |
| run: make installdeps | |
| - name: cargo fmt | |
| if: success() || failure() | |
| run: cargo fmt -- --check | |
| working-directory: ${{ matrix.crate }} | |
| - name: cargo clippy | |
| if: success() || failure() | |
| run: | | |
| cargo clippy --release -- -D warnings | |
| working-directory: ${{ matrix.crate }} | |
| benchmark-utils: | |
| # run only in pull requests | |
| if: github.event_name == 'pull_request' | |
| strategy: | |
| matrix: | |
| # we run benchmark tests only on ubuntu | |
| platform: [ ubuntu-latest ] | |
| crate: [ utils ] | |
| runs-on: ${{ matrix.platform }} | |
| timeout-minutes: 60 | |
| name: benchmark - ${{ matrix.platform }} - ${{ matrix.crate }} | |
| steps: | |
| - name: Checkout sources | |
| uses: actions/checkout@v3 | |
| - uses: Swatinem/rust-cache@v2 | |
| - uses: boa-dev/criterion-compare-action@v3 | |
| with: | |
| branchName: ${{ github.base_ref }} | |
| cwd: ${{ matrix.crate }} | |
| benchmark-rln: | |
| # run only in pull requests | |
| if: github.event_name == 'pull_request' | |
| strategy: | |
| matrix: | |
| # we run benchmark tests only on ubuntu | |
| platform: [ ubuntu-latest ] | |
| crate: [ rln ] | |
| feature: [ "default", "arkzkey" ] | |
| runs-on: ${{ matrix.platform }} | |
| timeout-minutes: 60 | |
| name: benchmark - ${{ matrix.platform }} - ${{ matrix.crate }} - ${{ matrix.feature }} | |
| steps: | |
| - name: Checkout sources | |
| uses: actions/checkout@v3 | |
| - uses: Swatinem/rust-cache@v2 | |
| - uses: boa-dev/criterion-compare-action@v3 | |
| with: | |
| branchName: ${{ github.base_ref }} | |
| cwd: ${{ matrix.crate }} | |
| features: ${{ matrix.feature }} |