initial draft

2025-09-24 20:45:28 +02:00
parent 075c3c3ef3
commit 872c37437b
4 changed files with 203 additions and 0 deletions
@@ -0,0 +1,76 @@
+# Setup Trivy Action
+
+A reusable Gitea Action that downloads and sets up the Trivy binary for vulnerability scanning.
+
+## Features
+
+- 🚀 Easy setup with minimal configuration
+- 🔧 Configurable Trivy version and architecture
+- ✅ Input validation and error handling
+- 🔄 Compatible with Gitea Actions and GitHub Actions
+- ⚡ **Smart caching** - Uses native GitHub Actions cache with proper cache-hit detection
+
+## Usage
+
+### Basic Usage
+
+```yaml
+- name: Setup Trivy
+  uses: your-username/trivy-actions@main/setup-trivy
+```
+
+### Advanced Usage
+
+```yaml
+- name: Setup Trivy
+  uses: your-username/trivy-actions@main/setup-trivy
+  with:
+    version: "v0.57.1" # Optional: Trivy version (default: v0.57.1)
+    architecture: "amd64" # Optional: amd64 or arm64 (default: amd64)
+```
+
+### Complete Example
+
+```yaml
+name: Security Scan
+on: [push, pull_request]
+
+jobs:
+  security:
+    runs-on:
+      - ubuntu-latest
+      - linux-amd64
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Trivy
+        uses: your-username/trivy-actions@main/setup-trivy
+        with:
+          version: "v0.57.1"
+          architecture: "amd64"
+
+      - name: Run Trivy vulnerability scanner
+        run: trivy fs .
+```
+
+## Action Steps
+
+The action is structured into logical steps for better maintainability:
+
+1. **Cache Trivy binary** - Uses `actions/cache@v4` to restore cached binary
+2. **Validate inputs** - Validates version and architecture parameters
+3. **Download and install Trivy** - Only runs on cache miss, downloads and installs binary
+4. **Add Trivy to PATH** - Ensures Trivy is available in subsequent steps
+5. **Verify Trivy installation** - Confirms installation and shows version
+
+## Inputs
+
+| Input          | Description                               | Required | Default   |
+| -------------- | ----------------------------------------- | -------- | --------- |
+| `version`      | Trivy version to download (e.g., v0.57.1) | No       | `v0.57.1` |
+| `architecture` | System architecture (amd64, arm64)        | No       | `amd64`   |
+
+## Supported Platforms
+
+- **Linux**: amd64, arm64