feat: add ssh key setup step (#131)

* feat: add ssh key setup step

* docs: update

Author: jsgalarraga

.github/workflows/dart_package.yml

@@ -55,6 +55,9 @@ on:
         required: false
         type: string
         default: "."
+    secrets:
+      ssh_key:
+        required: false
 
 jobs:
   build:
@@ -73,6 +76,14 @@ jobs:
         with:
           sdk: ${{inputs.dart_sdk}}
 
+      - name: 🤫 Set SSH Key
+        env:
+          ssh_key: ${{secrets.ssh_key}}
+        if: env.ssh_key != null
+        uses: webfactory/[email protected]
+        with:
+          ssh-private-key: ${{secrets.ssh_key}}
+
       - name: 📦 Install Dependencies
         run: dart pub get
 

.github/workflows/flutter_package.yml

@@ -59,6 +59,9 @@ on:
         required: false
         type: string
         default: "!*"
+    secrets:
+      ssh_key:
+        required: false
 
 jobs:
   build:
@@ -80,6 +83,14 @@ jobs:
           cache: true
           cache-key: flutter-:os:-:channel:-:version:-:arch:-:hash:-${{ hashFiles('**/pubspec.lock') }}
 
+      - name: 🤫 Set SSH Key
+        env:
+          ssh_key: ${{secrets.ssh_key}}
+        if: env.ssh_key != null
+        uses: webfactory/[email protected]
+        with:
+          ssh-private-key: ${{secrets.ssh_key}}
+
       - name: 📦 Install Dependencies
         run: |
           flutter pub global activate very_good_cli

site/docs/workflows/dart_package.md

@@ -97,6 +97,12 @@ The Dart package workflow consists of the following steps:
 
 **Default** `"vm"`
 
+## Secrets
+
+### `ssh_key`
+
+**Optional** An SSH key used to access private repositories when installing dependencies.
+
 ## Example Usage
 
 ```yaml
@@ -112,4 +118,6 @@ jobs:
       dart_sdk: 'stable'
       platform: 'chrome,vm'
       working_directory: 'examples/my_dart_package'
+    secrets:
+      ssh_key: ${{secrets.EXAMPLE_KEY}}
 ```

site/docs/workflows/flutter_package.md

@@ -104,6 +104,12 @@ The Flutter package workflow consists of the following steps:
 
 **Default** `"!*"`
 
+## Secrets
+
+### `ssh_key`
+
+**Optional** An SSH key used to access private repositories when installing dependencies.
+
 ## Example Usage
 
 ```yaml
@@ -120,4 +126,6 @@ jobs:
       flutter_version: '2.8.1'
       working_directory: 'examples/my_flutter_package'
       test_recursion: true
+    secrets:
+      ssh_key: ${{secrets.EXAMPLE_KEY}}
 ```