From 652a0bee3c6aaba4fb2ae596f1de42c51f8e81ec Mon Sep 17 00:00:00 2001 From: appleboy Date: Fri, 28 Nov 2025 22:55:57 +0800 Subject: [PATCH] docs: update CI documentation and workflow references - Clarify that the main CI workflow tests the local action, not just Docker containers - Add references to new workflows for testing the published tag and for automated security scanning - Explain the naming difference for the `INPUT_SCRIPT_FILE` environment variable - Update documentation to reflect default drone-ssh version change from 1.8.1 to 1.8.2 Signed-off-by: appleboy --- CLAUDE.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 9bc6009..d4f115f 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -37,7 +37,9 @@ This is a GitHub Action for executing remote SSH commands. Built using a composi - `action.yml` - Action metadata and input/output definitions - `entrypoint.sh` - Platform detection, binary download, and execution - `testdata/` - Test scripts and SSH keys for CI workflows -- `.github/workflows/main.yml` - Comprehensive test suite using Docker containers +- `.github/workflows/main.yml` - Comprehensive test suite using Docker containers (tests `./` local action) +- `.github/workflows/stable.yml` - Tests against published `appleboy/ssh-action@v1` tag +- `.github/workflows/trivy-scan.yml` - Automated security scanning for vulnerabilities and misconfigurations ## Testing @@ -92,7 +94,7 @@ export GITHUB_ACTION_PATH="$(pwd)" Users can provide scripts in two ways: - `script`: Inline commands (via `INPUT_SCRIPT`) -- `script_path`: Path to a file in the repository (via `INPUT_SCRIPT_FILE`) +- `script_path`: Path to a file in the repository (maps to `INPUT_SCRIPT_FILE` env var - note the naming difference) ### Error Handling @@ -160,7 +162,7 @@ Or use ED25519 keys instead (preferred). The action pins to specific drone-ssh versions via: -- Default: `DRONE_SSH_VERSION="1.8.1"` in `entrypoint.sh` +- Default: `DRONE_SSH_VERSION="1.8.2"` in `entrypoint.sh` - Override: Users can specify `version` input parameter Update the default version when new drone-ssh releases are available.