feat: allowing relocking for NPM updates (#20)

* feat: allowing relocking for NPM updates

* chore: cspell for 'relock'

Author: dotkas

.cspell.json

@@ -1,6 +1,6 @@
 {
   "language": "en",
-  "words": ["alchemaxinc"],
+  "words": ["alchemaxinc", "relock"],
   "files": ["*.md", "*/**/*.md"],
   "ignoreWords": [],
   "ignorePaths": [],

npm/README.md

@@ -24,19 +24,21 @@ jobs:
           branch-prefix: 'update-npm-deps'
           pr-title: 'Update NPM Dependencies'
           commit-message: 'Update NPM dependencies'
-          excluded-packages: 'package1,package2' # Optional
+          excluded-packages: 'package1,package2'
+          relock: false
 ```
 
 ## :gear: Inputs
 
-| Input               | Description                                 | Required           | Default                   |
-| ------------------- | ------------------------------------------- | ------------------ | ------------------------- |
-| `base-branch`       | Base branch for the pull request            | :white_check_mark: | `main`                    |
-| `token`             | GitHub token for authentication             | :x:                | `${{ github.token }}`     |
-| `branch-prefix`     | Prefix for the update branch                | :x:                | `update-dependencies`     |
-| `pr-title`          | Title for the pull request                  | :x:                | `Update NPM Dependencies` |
-| `commit-message`    | Commit message for the update               | :x:                | `Update NPM dependencies` |
-| `excluded-packages` | Comma-separated list of packages to exclude | :x:                | -                         |
+| Input               | Description                                      | Required           | Default                   |
+| ------------------- | ------------------------------------------------ | ------------------ | ------------------------- |
+| `base-branch`       | Base branch for the pull request                 | :white_check_mark: | `main`                    |
+| `token`             | GitHub token for authentication                  | :x:                | `${{ github.token }}`     |
+| `branch-prefix`     | Prefix for the update branch                     | :x:                | `update-dependencies`     |
+| `pr-title`          | Title for the pull request                       | :x:                | `Update NPM Dependencies` |
+| `commit-message`    | Commit message for the update                    | :x:                | `Update NPM dependencies` |
+| `excluded-packages` | Comma-separated list of packages to exclude      | :x:                | -                         |
+| `relock`            | Wether `package-lock.json` should be regenerated | :x:                | `false`                   |
 
 ## :warning: Prerequisites
 

npm/action.yml

@@ -32,6 +32,11 @@ inputs:
     required: false
     description: 'Packages to exclude from updates, in a comma-separated list format'
 
+  relock:
+    required: false
+    description: 'Whether package-lock.json should be regenerated, even if no other updates are available'
+    default: 'false'
+
 runs:
   using: 'composite'
   steps:
@@ -72,6 +77,9 @@ runs:
         else
           ncu -u
         fi
+        if [ "${{ inputs.relock }}" = "true" ]; then
+          rm -f package-lock.json
+        fi
         npm install
 
     - name: Check for changes