Added example to readme. Added types to inputs.

instructions-d-installation · Jul 7, 2024 · adb97d1 · adb97d1
1 parent f2cd919
commit adb97d1
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,8 +9,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-* Added example to readme.
+* Added examples to readme.
 * Added descriptions for input to readme.
+* Added types to inputs.
 
 
 ## [0.1.2] - 2024-06-26

diff --git a/README.md b/README.md
@@ -35,3 +35,22 @@
           path: ./install.cfg
           options: --something
 ```
+
+
+#### With `continue-on-error`
+
+Have a look at [contexts](https://docs.github.com/en/actions/learn-github-actions/contexts).
+
+```yaml
+    steps:
+      - name: Install from Config File
+        uses: instructions-d-installation/installation-instruction-action@0.1.2
+        id: install-another-id
+        continue-on-error: true
+        with:
+          path: ./install.cfg
+          options: --another
+          version: 0.4.0
+      - if: ${{ steps.install-another-id.outcome == "failure" }}
+        run: whatever
+```
diff --git a/action.yaml b/action.yaml
@@ -7,10 +7,13 @@ inputs:
   path:
     description: Path to directory, file or a remote git repository url containing the config file.
     required: true
+    type: string
   options:
     description: Options as string to pass to ibi cli. (Please check locally if it works.)
+    type: string
   version:
     description: Version of installation-instruction to use. If empty, uses the latest version.
+    type: string
 
 runs:
   using: composite