Skip to content

Latest commit

 

History

History
86 lines (60 loc) · 3.06 KB

README.md

File metadata and controls

86 lines (60 loc) · 3.06 KB

Run Leia Action

This is a GitHub action that runs Leia tests. It will use the leia in your package.json if it can and if it can't it will fallback to a globally installed version that is configurable with version.

Required Inputs

These keys must be set correctly for the action to work.

Name Description Example Value
leia-test The Leia test file to parse and run. examples/basics/README.md

NOTE: If you want to run multiple tests we recommend you set up a strategy matrix. See our dogfooded tests for an example.

Optional Inputs

These keys are set to sane defaults but can be modified as needed.

Name Description Default Example
cleanup-header The cleanup headers to parse. Clean,Tear,Burn Destroy
retry The amount of times to retry the test. 1 3
setup-header The setup headers to parse. Start,Setup,This is the dawning So it begins!
shell The shell to use. auto bash
stdin Attach stdin when the tests are run. false true
test-header The test headers to parse. Test,Validat,Verif Testing 1 2 3
timeout The amount of time for the test to run before a timeout, in seconds. 1800 7
version The fallback global version of Leia to install if no local version is detected. latest 0.6.5

NOTE: Please read Leia's shell considerations for details on how shell: auto works.

Usage

Basic Usage

- name: Run Leia Tests
  uses: lando/run-leia-action@v2
  with:
    leia-test: tests/leia-test-1.md

Advanced Usage

Everything, everywhere, all at once:

- name: Run Leia Tests
  uses: lando/run-leia-action@v2
  with:
    leia-test: tests/leia-test-1.md
    debug: true
    cleanup-header: Clean
    retry: 0
    setup-header: Setup
    shell: bash
    stdin: true
    test-header: Test
    timeout: 5
    version: "^0.6.5"

Changelog

We try to log all changes big and small in both THE CHANGELOG and the release notes.

Releasing

Create a release and publish to GitHub Actions Marketplace. Note that the release tag must be a semantic version.

Maintainers

Contributors

Made with contrib.rocks.

Other Resources