README.md

Bulloak Toolchain

This GitHub Action installs the Bulloak toolchain and check that Solidity tests conform to BTT spec.

Example workflow

name: "Test"

on:
  push:
    branches:
      - main

jobs:
  ci:
    runs-on: "ubuntu-latest"
    steps:
      - name: "Check out the repo"
        uses: "actions/checkout@v4"

      - name: "Install and run Bulloak"
        uses: "smol-ninja/bulloak-toolchain@v1"
        with:
          skip-modifiers: "false"
          test-dir: "test-workspace"

Inputs

Name	Description	Default	Required?
cache	Automatically configure Rust cache	true	No
cache-key	A custom key to identify the cache	"${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}"	No
cache-restore-keys	A custom key to identify the cache to restore	"${{ runner.os }}-cargo-"	No
save-always	Save the cache even if a prior step fails	true	No
skip-modifiers	Whether to ignore modifiers declaration in the Solidity test contracts	false	No
test-dir	The test directory which would usually be test		Yes

Outputs

Name	Description
bulloak-version	Version as reported by bulloak --version

Contributors

• PaulRBerg - For the initial idea and motivation.
• alexfertel - For his amazing work on Bulloak.
• andreivladbrg - For feedback on the implementation of BTT.

License

This project is released under the MIT License.