Add docs and some minor cleanups #525
Workflow file for this run
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
| --- | |
| name: Build | |
| on: | |
| pull_request: | |
| branches: ["main"] | |
| push: | |
| branches: ["main"] | |
| jobs: | |
| build: | |
| name: Build | |
| runs-on: ubuntu-22.04 | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| name: [ossl3, fips, release, dynamic, i686, minimal] | |
| db: [jsondb, sqlitedb, nssdb] # FIXME: Add "memorydb" when it will be persistent | |
| container: fedora:latest | |
| steps: | |
| - name: Get Date for DNF cache entry | |
| id: get-date | |
| run: | | |
| echo "date=$(/bin/date -u "+%Y%V")" >> $GITHUB_OUTPUT | |
| shell: bash | |
| - name: Store DNF cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| /var/cache/dnf | |
| key: ${{ runner.os }}-dnf-${{ steps.get-date.outputs.date }} | |
| - name: Install Dependencies | |
| run: | | |
| dnf -y install git cargo clang-devel openssl-devel \ | |
| 'perl(FindBin)' 'perl(lib)' 'perl(File::Compare)' \ | |
| 'perl(File::Copy)' 'perl(bigint)' 'perl(Time::HiRes)' \ | |
| 'perl(IPC::Cmd)' 'perl(Pod::Html)' 'perl(Digest::SHA)' \ | |
| 'perl(Module::Load::Conditional)' 'perl(File::Temp)' \ | |
| 'perl(Test::Harness)' 'perl(Test::More)' 'perl(Math::BigInt)' \ | |
| zlib-devel sed sqlite-devel | |
| if [ "${{ matrix.name }}" = "i686" ]; then | |
| dnf -y install rust-std-static.i686 openssl-devel.i686 \ | |
| sqlite-devel.i686 | |
| fi | |
| - name: Checkout Repository | |
| uses: actions/checkout@v4 | |
| - name: Setup | |
| run: | | |
| git config --global --add safe.directory /__w/kryoptic/kryoptic | |
| git submodule init | |
| git submodule update | |
| - name: Restore OpenSSL build | |
| uses: actions/cache/restore@v4 | |
| id: cache | |
| with: | |
| path: | | |
| openssl/ | |
| key: ${{ runner.os }}-ossl-${{ hashFiles('.git/modules/openssl/HEAD') }} | |
| - name: Generate lock file | |
| run: cargo generate-lockfile | |
| - name: Cache Rust dependencies | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| ~/.cargo/bin/ | |
| ~/.cargo/registry/index/ | |
| ~/.cargo/registry/cache/ | |
| ~/.cargo/git/db/ | |
| target/ | |
| key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }} | |
| - name: Build & test | |
| run: | | |
| FEATURES="${{ matrix.db }}" | |
| OPTS="" | |
| if [ "${{ matrix.name }}" = "fips" ]; then | |
| FEATURES="${FEATURES},fips" | |
| elif [ "${{ matrix.name }}" = "ossl3" ]; then | |
| FEATURES="${FEATURES},standard" | |
| elif [ "${{ matrix.name }}" = "release" ]; then | |
| FEATURES="${FEATURES},standard" | |
| OPTS="--release" | |
| elif [ "${{ matrix.name }}" = "dynamic" ]; then | |
| FEATURES="${FEATURES},standard,dynamic" | |
| OPTS="--release" | |
| elif [ "${{ matrix.name }}" = "i686" ]; then | |
| FEATURES="${FEATURES},standard,dynamic" | |
| OPTS="--target i686-unknown-linux-gnu" | |
| elif [ "${{ matrix.name }}" = "minimal" ]; then | |
| OPTS="--no-default-features" | |
| fi | |
| cargo build -vv $OPTS --features "$FEATURES" | |
| cargo test -vv $OPTS --features "$FEATURES" | |
| - uses: actions/upload-artifact@v4 | |
| if: failure() | |
| with: | |
| name: Build logs ${{ matrix.db }} ${{ matrix.name }} | |
| path: | | |
| target/debug/build/*/output | |
| - if: ${{ matrix.name == 'fips' && steps.cache.outputs.cache-hit != 'true' }} | |
| name: Cache OpenSSL FIPS build (usable also for default, not vice versa) | |
| uses: actions/cache/save@v4 | |
| with: | |
| path: | | |
| openssl/ | |
| key: ${{ runner.os }}-ossl-${{ hashFiles('.git/modules/openssl/HEAD') }} |