Skip to content

Commit ffbb7e4

Browse files
committed
WIP Documents the new dedicated commands
1 parent 07ff70c commit ffbb7e4

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,9 @@ with a nonexistent `.gitattributes` file implicates the `--create` option.
9090
``` bash
9191
lean-package-validator validate --overwrite [<directory>]
9292
```
93+
> [!WARNING]
94+
> As of release `v5.0` the `--create` and `--overwrite` options are deprecated and will be removed in the next major
95+
> release. Please migrate to the dedicated commands `create` and `update`.
9396
9497
The `--glob-pattern` option allows you to overwrite the default pattern used
9598
to match common repository artifacts. The amount of pattern in the grouping
@@ -193,6 +196,17 @@ cat .gitattributes | lean-package-validator validate --stdin-input
193196

194197
### Additional commands
195198

199+
#### Create command
200+
201+
The `create` command will create a `.gitattributes` file in the given directory. This command replaces the `--create`
202+
option of the `validate` command. Please migrate to the dedicated commands.
203+
204+
205+
#### Update command
206+
207+
The `update` command will update a present `.gitattributes` file in the given directory. This command replaces the `--overwrite`
208+
option of the `validate` command. Please migrate to the dedicated commands.
209+
196210
#### Init command
197211

198212
The `init` command will create an initial `.lpv` file with the default patterns used to match common repository artifacts.

0 commit comments

Comments
 (0)