feat: add auto-config and build inputs.
#61
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closed
Closed
|
For a better idea of how these options are presented to users see the new |
austinletson
commented
Jul 1, 2024
| @@ -26,15 +26,95 @@ jobs: | |||
| - uses: leanprover/lean-action@v1-beta | |||
| ``` | |||
|
|
|||
| ## Configuring which features `lean-action` runs | |||
There was a problem hiding this comment.
@semorrison I don't think you need to go through the entire change set of this PR, however could you take a look at this new section of the README which outlines how users will configure lean-action moving forward to confirm this is the right direction.
Note, the plan is to include lake lint in the list of features which can be automatically configured (using lake check-lint).
austinletson
force-pushed
the
60-create-auto-config-input
branch
from
fb1df33 to
950b45b
Compare
`auto-config` allows users to specify if `lean-action` should use the Lake workspace to automatically decide which CI features to run. `build` allows users to specify if `lean-action` runs `lake build`. By default, `auto-config: true`. The `test` and `build` (and soon `lint`, see #46) inputs allow users to override the automatically configured behavior or configure `lean-action` when `auto-config: false`. `auto-config: true` is close to the previous default behavior, however there is a difference in the outcome of the `lake test` step. When users set `test: true` manually, `lean-action` must find tests with `lake check-test` and run `lake test` or it will fail (this was the previous behavior). However with `auto-config: true`, if `lake check-test` fails, `lean-action` will not run `lake test` and this won't cause `lean-action` to fail.
austinletson
force-pushed
the
60-create-auto-config-input
branch
from
950b45b to
411c31e
Compare
|
I am going to go ahead and merge this to keep things moving toward v1. We can revisit the inputs at any time. The behavior of |
This was referenced Jul 11, 2024
oliver-butterley
pushed a commit
to oliver-butterley/lean-update
that referenced
this pull request
Jul 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
auto-configallows users to specify iflean-actionshould use the Lake workspace to automatically decide which CI features to run.buildallows users to specify iflean-actionrunslake build.By default,
auto-config: true.The
testandbuild(and soonlint, see #46) inputs allow users to override the automatically configured behavior or configurelean-actionwhenauto-config: false.auto-config: trueis close to the previous default behavior, however there is a difference in the outcome of thelake teststep. When users settest: truemanually,lean-actionmust find tests withlake check-testand runlake testor it will fail (this was the previous behavior). However withauto-config: true, iflake check-testfails,lean-actionwill not runlake testand this won't causelean-actionto fail.Closes #60, #53, and #30.