Skip to content

feat: add leanchecker-args input #162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kim-em wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add leanchecker-args input #162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## Unreleased

### Added

- new `leanchecker-args` input to pass arguments to `lake env leanchecker`,
e.g. `leanchecker-args: "-v"` for verbose output or explicit module prefixes
such as `leanchecker-args: "MyPkg.Core"` to narrow the set of modules checked

## v1.5.0 - 2026-04-21

### Added
Expand Down
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,13 @@ To be certain `lean-action` runs a step, specify the desire feature with a featu
# Default: "false"
leanchecker: ""

# Extra arguments to pass to `lake env leanchecker {leanchecker-args}`.
# For example, `leanchecker-args: "-v"` enables verbose output, and
# `leanchecker-args: "MyPkg.Core MyPkg.Extras"` restricts checking to the
# listed module prefixes. Only takes effect when `leanchecker: true`.
# Default: ""
leanchecker-args: ""

# Deprecated alias for `leanchecker`.
lean4checker: ""

Expand Down
11 changes: 11 additions & 0 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,16 @@ inputs:
Allowed values: "true" | "false".
required: false
default: "false"
leanchecker-args:
description: |
Extra arguments to pass to `lake env leanchecker {leanchecker-args}`.
For example, `leanchecker-args: "-v"` enables verbose output, and
`leanchecker-args: "MyPkg.Core MyPkg.Extras"` restricts checking to the
listed module prefixes.
By default, `lean-action` calls `lake env leanchecker` with no arguments,
which checks every module in the root package.
required: false
default: ""
lean4checker:
description: |
Deprecated alias for `leanchecker`.
Expand Down Expand Up @@ -286,6 +296,7 @@ runs:
env:
LEANCHECKER_INPUT: ${{ inputs.leanchecker }}
LEAN4CHECKER_INPUT: ${{ inputs.lean4checker }}
LEANCHECKER_ARGS: ${{ inputs.leanchecker-args }}
run: |
: Check Environment with leanchecker
${GITHUB_ACTION_PATH}/scripts/run_leanchecker.sh
Expand Down
6 changes: 4 additions & 2 deletions scripts/run_leanchecker.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ fi
leanchecker_path="$(elan which leanchecker 2>/dev/null || true)"
if [ -n "$leanchecker_path" ] && [ -x "$leanchecker_path" ]; then
echo "Using bundled leanchecker from the active Lean toolchain"
lake env leanchecker
# use eval to ensure leanchecker arguments are expanded
eval "lake env leanchecker ${LEANCHECKER_ARGS:-}"
echo "::endgroup::"
echo
exit 0
Expand Down Expand Up @@ -40,7 +41,8 @@ fi
)

echo "Running external lean4checker"
lake env lean4checker/.lake/build/bin/lean4checker
# use eval to ensure leanchecker arguments are expanded
eval "lake env lean4checker/.lake/build/bin/lean4checker ${LEANCHECKER_ARGS:-}"

echo "::endgroup::"
echo
Loading