feat: add reusable truenas-deploy composite action

2026-10-13 09:36:00 -07:00
parent 40c5bc78f1
commit 4b2856c065
3 changed files with 107 additions and 1 deletions
@@ -0,0 +1,23 @@
+# Deploy to TrueNAS (`truenas-deploy`)
+
+Deploys a Docker Compose stack directly to TrueNAS SCALE (`/mnt/jupiter/apps/<app_name>`) over SSH and runs `docker compose pull && docker compose up -d --remove-orphans`.
+
+## Usage
+
+```yaml
+- name: Deploy to TrueNAS
+  uses: https://git.rodydavis.dev/rodydavis/shared-actions/truenas-deploy@main
+  with:
+    ssh_key: ${{ secrets.TRUENAS_SSH_KEY }}
+```
+
+### Optional Inputs
+
+| Input | Description | Default |
+| :--- | :--- | :--- |
+| `ssh_key` | **(Required)** Private SSH key for authenticating to TrueNAS (`secrets.TRUENAS_SSH_KEY`). | — |
+| `app_name` | Application directory name under `/mnt/jupiter/apps/<app_name>`. | Repository name |
+| `compose_file` | Local compose file path (auto-detects `docker-compose.yaml` or `docker-compose.yml`). | `docker-compose.yaml` |
+| `host` | TrueNAS SSH host IP or hostname. | `10.0.0.218` |
+| `user` | TrueNAS SSH user. | `root` |
+| `env_file_content` | Optional `.env` file contents to write to `/mnt/jupiter/apps/<app_name>/.env`. | `''` |