Skip to content

Commit 652a0be

Browse files
committed
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 <[email protected]>
1 parent 4e3535e commit 652a0be

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

CLAUDE.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,9 @@ This is a GitHub Action for executing remote SSH commands. Built using a composi
3737
- `action.yml` - Action metadata and input/output definitions
3838
- `entrypoint.sh` - Platform detection, binary download, and execution
3939
- `testdata/` - Test scripts and SSH keys for CI workflows
40-
- `.github/workflows/main.yml` - Comprehensive test suite using Docker containers
40+
- `.github/workflows/main.yml` - Comprehensive test suite using Docker containers (tests `./` local action)
41+
- `.github/workflows/stable.yml` - Tests against published `appleboy/ssh-action@v1` tag
42+
- `.github/workflows/trivy-scan.yml` - Automated security scanning for vulnerabilities and misconfigurations
4143

4244
## Testing
4345

@@ -92,7 +94,7 @@ export GITHUB_ACTION_PATH="$(pwd)"
9294
Users can provide scripts in two ways:
9395

9496
- `script`: Inline commands (via `INPUT_SCRIPT`)
95-
- `script_path`: Path to a file in the repository (via `INPUT_SCRIPT_FILE`)
97+
- `script_path`: Path to a file in the repository (maps to `INPUT_SCRIPT_FILE` env var - note the naming difference)
9698

9799
### Error Handling
98100

@@ -160,7 +162,7 @@ Or use ED25519 keys instead (preferred).
160162

161163
The action pins to specific drone-ssh versions via:
162164

163-
- Default: `DRONE_SSH_VERSION="1.8.1"` in `entrypoint.sh`
165+
- Default: `DRONE_SSH_VERSION="1.8.2"` in `entrypoint.sh`
164166
- Override: Users can specify `version` input parameter
165167

166168
Update the default version when new drone-ssh releases are available.

0 commit comments

Comments
 (0)