Skip to content

Commit

Permalink
doc: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
austinletson committed May 10, 2024
1 parent 83ea139 commit e9bbbf3
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 3 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,14 @@ jobs:
# Allowed values: "true" or "false".
# Default: false
check-reservoir-eligibility: false


# Check environment with lean4checker.
# Lean version must be 4.8 or higher.
# The version of lean4checker is automatically detected using `lean-toolchain`.
# Allowed values: "true" or "false".
# Default: false
lean4checker: false
```
## Examples
Expand Down
6 changes: 4 additions & 2 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,14 @@ inputs:
description: |
Check if the repository is eligible for the reservoir.
Allowed values: "true" or "false".
If check-reservoir-elibility input is not provided, the action will not check for reservoir eligibility.
If check-reservoir-eligibility input is not provided, the action will not check for reservoir eligibility.
required: false
default: "false"
lean4checker:
description: |
Check environment with lean4checker
Check environment with lean4checker.
Lean version must be 4.8 or higher.
The version of lean4checker is automatically detected using `lean-toolchain`.
Allowed values: "true" or "false".
If lean4checker input is not provided, the action will not check the environment with lean4checker.
required: false
Expand Down
2 changes: 1 addition & 1 deletion scripts/run_lean4checker.sh
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ git clone https://github.com/leanprover/lean4checker
toolchain_version=$(< lean-toolchain cut -d: -f 2)
echo "Detected toolchain version: $toolchain_version"
cd lean4checker || exit
git config --global advice.detachedHead false # turn off git warning about detached head
git config advice.detachedHead false # turn off git warning about detached head
git checkout "$toolchain_version"
cp ../lean-toolchain .

Expand Down

0 comments on commit e9bbbf3

Please sign in to comment.