init

Author: KillerCodeMonkey

.eslintignore

@@ -0,0 +1 @@
+dist

.eslintrc

@@ -0,0 +1,7 @@
+{
+  "env": {
+    "node": true,
+    "es6": true
+  },
+  "extends": "eslint:recommended"
+}

.github/workflows/test.yml

@@ -0,0 +1,41 @@
+name: test
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Create test folder
+      run: |
+        mkdir test
+        mkdir test2
+
+    - name: Create package.json with different versions
+      run: |
+        echo '{"version": "1.0.0","name": "my-package"}' > test2/other_name.json
+        echo '{"version": "1.0.0","name": "my-package"}' > test2/other_name-lock.json
+        echo '{"version": "1.2.0","name": "my-package"}' > test/package.json
+        echo '{"version": "1.2.0","name": "my-package"}' > test/package-lock.json
+      
+    - name: simple without version
+      uses: ./
+      id: simpleWithoutVersion
+      with:
+        packageJSON: test/package.json
+        packageJSONLock: test/package-lock.json
+
+    - name: diff without version
+      uses: ./
+      id: diffWithoutVersion
+      with:
+        packageJSON: test2/other_name.json
+        packageJSONLock: test2/other_name-lock.json
+
+    - name: test
+      if: steps.simpleWithoutVersion.outputs.cacheKey != steps.diffWithoutVersion.outputs.cacheKey
+      run: |
+        echo "Received different cache keys for lock files"
+        exit 1

.gitignore

@@ -0,0 +1 @@
+node_modules

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 codaline.io
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,34 @@
+# node-versionless-cache-key
+
+This action generates a cache key out of the package.json and package-lock.json.
+
+The Problem: The package-lock.json contains the package version. If that versions changes the hash of the file changes. To avoid getting a new cache key, when your package version changes this actions strips the version.
+
+It accepts a package.json and package-lock.json file path.
+Nothing special is happening. Just replacing the version in package-lock and getting a hash back.
+
+## What is happening
+
+1.   reads json files
+2.   grab package name from package.json
+3.   search for that package name and its following version key in package-lock.json
+4.   replaces all whitespaces, tabs and newlines and the version number with empty string
+5.   Creates and outputs the new version
+
+## Inputs
+
+- **branch**: The name of the branch to check if the current branch is master or a dev-branch. Default `master`.
+- **filePath**: The json file path or file name where the `version` field is present. Default `package.json`.
+
+## Outputs
+
+- **version**: The generated version number.
+
+## Example usage
+
+```
+uses: codaline-io/[email protected]
+with:
+  branch: feat/dev-branch
+  filePath: ./package.json
+```

action.yml

@@ -0,0 +1,20 @@
+name: 'Node versionless cache key'
+description: 'Creates a hash of package-lock.json without the package version'
+branding:
+  color: orange
+  icon: airplay
+inputs:
+  packageJSON:
+    description: 'Path to package.json'
+    required: false
+    default: 'package.json'
+  packageLockJSON:
+    description: 'Path to package-lock.json'
+    required: false
+    default: 'package-lock.json'
+outputs:
+  cacheKey:
+    description: 'cache key of package-lock.json without version'
+runs:
+  using: 'node16'
+  main: 'dist/index.js'