actions/ssh-action
0
0
Fork 0
mirror of https://github.com/appleboy/ssh-action.git synced 2025-11-28 23:27:13 -05:00
Code Issues Packages Projects Releases 1 Wiki Activity

docs: update CI documentation and workflow references

Browse Source 
- 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 <appleboy.tw@gmail.com>
This commit is contained in:
appleboy
2025-11-28 22:55:57 +08:00
parent 4e3535e14e
commit 652a0bee3c
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
CLAUDE.md
View File

@@ -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 - `action.yml` - Action metadata and input/output definitions
- `entrypoint.sh` - Platform detection, binary download, and execution - `entrypoint.sh` - Platform detection, binary download, and execution
- `testdata/` - Test scripts and SSH keys for CI workflows - `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 ## Testing
@@ -92,7 +94,7 @@ export GITHUB_ACTION_PATH="$(pwd)"
Users can provide scripts in two ways: Users can provide scripts in two ways:
- `script`: Inline commands (via `INPUT_SCRIPT`) - `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 ### Error Handling
@@ -160,7 +162,7 @@ Or use ED25519 keys instead (preferred).
The action pins to specific drone-ssh versions via: 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 - Override: Users can specify `version` input parameter
Update the default version when new drone-ssh releases are available. Update the default version when new drone-ssh releases are available.