From c4e9bea5a5da51286691bf1fa193067d52e9f075 Mon Sep 17 00:00:00 2001 From: bjarneo Date: Sun, 17 Nov 2024 18:08:56 +0100 Subject: [PATCH] docs: add action input to readme --- README.md | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fe0106b..89abe3b 100644 --- a/README.md +++ b/README.md @@ -179,7 +179,7 @@ jobs: with: host: remote_host.com user: deploy_user - ssh_key: + ssh_key: ${{ secrets.PRIVATE_SSH_KEY }} image: myapp tag: ${{ steps.get_version.outputs.VERSION }} container_name: myapp_prod @@ -224,7 +224,7 @@ jobs: with: host: remote_host.com user: deploy_user - ssh_key: ~/.ssh/deploy_key + ssh_key: ${{ secrets.PRIVATE_SSH_KEY }} image: myapp container_name: myapp_prod container_port: 3000 @@ -234,6 +234,30 @@ jobs: rollback: true ``` +## GitHub Action Inputs + +When using Copepod as a GitHub Action, the following inputs are available: + +| Input | Required | Default | Description | +|------------------|----------|----------------|-------------------------------------------------| +| host | Yes | | Remote host to deploy to | +| user | Yes | | SSH user for remote host | +| ssh_key | Yes | | SSH private key for authentication | +| image | No | copepod_app | Docker image name | +| tag | No | latest | Docker image tag | +| platform | No | linux/amd64 | Docker platform | +| container_name | No | copepod_app | Name for the container | +| container_port | No | 3000 | Container port | +| host_port | No | 3000 | Host port | +| env_file | No | | Path to environment file | +| dockerfile | No | Dockerfile | Path to Dockerfile | +| build_args | No | | Build arguments (comma-separated KEY=VALUE pairs)| +| rollback | No | false | Whether to perform a rollback | +| network | No | | Docker network to connect to | +| volume | No | | Volume mount (host:container) | +| cpus | No | | Number of CPUs | +| memory | No | | Memory limit | + ## Deployment Process 1. Validates configuration and checks prerequisites