docs: add example to bump mix project version

Byzanteam · Apr 21, 2024 · d45e286 · d45e286
1 parent 54f422c
commit d45e286
Showing 1 changed file with 31 additions and 0 deletions.
diff --git a/denoified-actions/README.md b/denoified-actions/README.md
@@ -21,3 +21,34 @@
     repository: ${{ github.repository }}
     release-kind: ${{ inputs.releaseKind }}
 ```
+
+**example**
+```yaml
+name: Version bump
+
+on:
+  workflow_dispatch:
+    inputs:
+      releaseKind:
+        description: 'Kind of version bump'
+        default: 'patch'
+        type: choice
+        options:
+          - patch
+          - minor
+          - major
+        required: true
+
+jobs:
+  bump:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - uses: Byzanteam/jet-actions/denoified-actions/elixir/bump_version@main
+        with:
+          gh-token: ${{ secrets.GITHUB_TOKEN }}
+          workflow-actor: ${{ github.actor }}
+          repository: ${{ github.repository }}
+          release-kind: ${{ inputs.releaseKind }}
+```