feat(yarn2-install): add yarn-args input

myparcelnl · Oct 24, 2022 · aa09627 · aa09627
1 parent 4cb7e27
commit aa09627
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -125,8 +125,16 @@ For use with Yarn 2 (berry).
 - uses: myparcelnl/actions/yarn2-install@v2
   with:
     node-version: 16
+    yarn-args: --immutable --immutable-cache
 ```
 
+##### Inputs
+
+| required | name           | description                        | Example                         | Default |
+|----------|----------------|------------------------------------|---------------------------------|---------|
+| No       | `node-version` | The Node.js version to use         | `16`                            | `16`    |
+| No       | `yarn-args`    | Arguments to use with yarn install | `--immutable --immutable-cache` | ` `     |
+
 #### pnpm-install
 
 [Source](pnpm-install/action.yml)

diff --git a/yarn2-install/action.yml b/yarn2-install/action.yml
@@ -1,12 +1,17 @@
-name: Install yarn 2 dependencies
-description: Install yarn 2 dependencies from scratch or from cache
+name: 'Install yarn 2 dependencies'
+description: 'Install yarn 2 dependencies from scratch or from cache'
 
 inputs:
   node-version:
     description: 'The Node.js version to use'
     default: '16'
     required: false
 
+  yarn-args:
+    description: 'Arguments to use with yarn install'
+    default: ''
+    required: false
+
 runs:
   using: composite
   steps:
@@ -16,5 +21,5 @@ runs:
         cache: 'yarn'
 
     - name: 'Install yarn dependencies'
-      run: yarn install
+      run: yarn install ${{ inputs.yarn-args }}
       shell: bash