README.md

January 11, 2025 ยท View on GitHub

Huff Neo Tests Github Action

Github Action that:

  1. Checks out your local repository
  2. Installs Huff Neo Compiler
  3. Runs Huff tests on any files that match the default or specified parameters:
    • Named *.t.huff or the specified extension
    • Located in src or the specified directory
    • With the specified output or list

Example Workflow

name: Huff tests

on: [push]

jobs:
  tests:
    name: Tests with Huff
    runs-on: ubuntu-latest
    steps:
      - name: Run Huff Tests
        uses: cakevm/huff-neo-tests-action@v1
        with:
          # Below arguments are optional:
          with-location: "tests" # Defaults to "src"
          with-extension: "*.t.huff" # Defaults to "*.t.huff*"
          with-format: "table" # Defaults to "list"

Inputs

NameRequiredDescriptionType
with-extensionFalseThe extension of your huff tests, e.g. t.huff or .poggers.huff.string
with-locationFalseThe location of your huff test files, e.g. src or contractsstring
with-formatFalseThe format of your huff test output. One of ["list", "table", "json"].string

Contributing

All contributions are welcome.

Acknowledgements

Many thanks to the original huff-tests-action for the initial version.

License

This project is licensed under the Apache-2.0 License - see the LICENSE file for details.