Skip to content

Commit 637e2b7

Browse files
docs: fix docu
1 parent 18dbe14 commit 637e2b7

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,22 @@ Nothing special is happening. Just replacing the version in package-lock and get
1313
2. grab package name from package.json
1414
3. search for that package name and its following version key in package-lock.json
1515
4. replaces all whitespaces, tabs and newlines and the version number with empty string
16-
5. Creates and outputs the new version
16+
5. hashes the file content and output it as cache key
1717

1818
## Inputs
1919

20-
- **branch**: The name of the branch to check if the current branch is master or a dev-branch. Default `master`.
21-
- **filePath**: The json file path or file name where the `version` field is present. Default `package.json`.
20+
- **packageJSON**: path to package.json file. Default `./package.json`.
21+
- **packageLockJSON**: path to package-lock.json file. Default `./package-lock.json`.
2222

2323
## Outputs
2424

25-
- **version**: The generated version number.
25+
- **cacheKey**: The generated hash over package-lock.json without version number.
2626

2727
## Example usage
2828

2929
```
3030
uses: codaline-io/[email protected]
3131
with:
32-
branch: feat/dev-branch
33-
filePath: ./package.json
32+
packageJSON: custom-sub-folder/package-test.json
33+
packageLockJSON: custom-sub-folder/my-lock-file.json
3434
```

0 commit comments

Comments
 (0)