v1

2026-05-02 22:36:11 +02:00
commit 0ce01833a4
2 changed files with 67 additions and 0 deletions
@@ -0,0 +1,30 @@
+# Stapler Deploy
+
+## Sample CI
+
+```yaml
+name: Docker Build CI
+on: [ push ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/stapler-deploy@v1
+        with:
+          path: dist
+          token: ${{ secrets.STAPLER_TOKEN }}
+          target: ${{ github.repository }}
+          extra_curl_args: ${{ vars.STAPLER_CURL_ARGS }}
+```
+
+## Arguments
+
+| Name | Description | Default value |
+| --- | --- | --- |
+| `path` | directory path to deploy | `.` |
+| `token` | Stapler token | (required) |
+| `host` | Stapler host | `https://stapler.fr` |
+| `target` | Stapler target path | (required) |
+| `extra_curl_args` | Extra Curl args like: -H 'X-Host-Only: example.org' | (empty) |