-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: create v4.md to document breaking changes
- Loading branch information
1 parent
e87173f
commit 433c3b8
Showing
1 changed file
with
11 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Upgrade from v3 to v4 | ||
|
||
- `actions-node/lint`: This update changes the action's behavior from just running `eslint` to running an npm script passed by the consumer that would run all the lint checks they need. | ||
|
||
## Description of changes | ||
|
||
- `actions-node/lint`: The action now takes an input `lint-script`, which is the name of the npm script it is going to run as the primary lint check. The default value of the input is `lint`, meaning the action will run `yarn lint` or `npm run lint` depending on the package manager the consumer is using (which is picked up automatically). | ||
|
||
## Upgrade instructions | ||
|
||
- `actions-node/lint`: If the npm script to lint your code locally is anything other than `lint`, pass it to the `lint-script` input. |