Skip to content

Commit

Permalink
doc: improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
austinletson committed Jun 10, 2024
1 parent e4239c4 commit 129f3e1
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ Here are the steps to create a new test:
- Write a meaningful description of what use cases your test covers.
- If appropriate, you can parameterize your test with action inputs for more flexibility (see the `.github/functional_tests/lake_init` directory for an example).
- For more information on the action syntax, see [creating a composite action](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action).
- Create a final step in your test which verifies the outputs of `lean-action` using `verify_action_outputs.sh`.
- Create a new job in `.github/workflows/functional_tests.yml` with a call to the newly created action.


### Running functional tests locally with `act`
`lean-action` developers can leverage [act](https://github.com/nektos/act) to run tests locally.

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ jobs:
with:
test: true

- name: verify lean-action outputs
- name: log `lean-action` `test-status` output
env:
TEST_STATUS: ${{ steps.lean-action.outputs.test-status }}
run: echo "Test status: $TEST_STATUS"
Expand Down

0 comments on commit 129f3e1

Please sign in to comment.