Skip to content

Commit

Permalink
doc: add example of environment usage in later steps
Browse files Browse the repository at this point in the history
  • Loading branch information
austinletson committed May 20, 2024
1 parent a9d0660 commit 5aa3f5b
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jobs:
# Allowed values: "true" or "false".
# Default: true
test: true

# Build arguments to pass to `lake build {args}`.
# For example, `build-args: "--quiet"` will run `lake build --quiet`.
build-args: ""
Expand Down Expand Up @@ -93,6 +93,24 @@ jobs:
build-args: "--wfail"
```

### Run additional steps after `lean-action` using the Lean environment

After calling `lean-action` you can leverage the Lean environment in later workflow steps.

For example, `leanprover-community/import-graph` uses the setup from `lean-action` to test the `graph` executable with `lake exe graph`:

```lean
steps:
- uses: leanprover/lean-action@v1-alpha
with:
check-reservoir-eligibility: true
# use setup from lean-action to perform the following steps
- name: verify `lake exe graph` works
run: |
lake exe graph
rm import_graph.dot
```
## Projects which use `lean-action`
- [leanprover-community/aesop](https://github.com/leanprover-community/aesop/blob/master/.github/workflows/build.yml#L16)
- [leanprover-community/import-graph](https://github.com/leanprover-community/import-graph/blob/main/.github/workflows/build.yml#L8)
Expand Down

0 comments on commit 5aa3f5b

Please sign in to comment.