Skip to content

Commit 41cc843

Browse files
committed
Improve action documentation and branding
- Updated action description to mention both action and command modes - Added branding icon and color - Updated README to reflect the current witness version (0.8.1) - Added clearer documentation about input forwarding - Improved action reference description - Enhanced input-* parameter description for clarity
1 parent 747489a commit 41cc843

File tree

2 files changed

+20
-8
lines changed

2 files changed

+20
-8
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# TestifySec Action Wrapper with Witness
22

3-
A GitHub Action that downloads and executes another GitHub Action with Witness attestation.
3+
A GitHub Action that downloads and executes another GitHub Action or direct command with Witness attestation for supply chain security.
44

55
## Usage
66

@@ -67,6 +67,14 @@ This action combines the functionality of a GitHub Action wrapper with Witness a
6767
3. **Runs with Attestation**: The action is executed through Witness, which creates attestations
6868
4. **Stores Results**: Attestations are stored (optionally in Archivista) and GitOIDs are returned
6969
70+
### Input Forwarding
71+
72+
The action wrapper passes inputs to the nested action with a special prefix convention:
73+
74+
- Any input parameter starting with `input-` will have the prefix removed and be passed to the nested action
75+
- For example, `input-who-to-greet: "World"` becomes `who-to-greet: "World"` for the nested action
76+
- This allows you to clearly separate inputs meant for the wrapper action from those meant for the nested action
77+
7078
## Key Features
7179

7280
- **GitHub Action Execution**: Run any JavaScript GitHub Action
@@ -90,7 +98,7 @@ This action combines the functionality of a GitHub Action wrapper with Witness a
9098

9199
| Input | Description | Required | Default |
92100
|-------|-------------|----------|---------|
93-
| `witness-version` | Version of Witness to use | No | `0.2.11` |
101+
| `witness-version` | Version of Witness to use | No | `0.8.1` |
94102
| `witness-install-dir` | Directory to install Witness | No | `./` |
95103

96104
### Witness Core Options
@@ -159,7 +167,7 @@ This action combines the functionality of a GitHub Action wrapper with Witness a
159167

160168
| Input | Description | Required | Default |
161169
|-------|-------------|----------|---------|
162-
| `input-*` | Any input with the prefix `input-` will be passed to the nested action | No | |
170+
| `input-*` | Any input with the prefix `input-` will be passed to the nested action without the prefix (e.g., input-who-to-greet becomes who-to-greet) | No | |
163171
| `extra-args` | Extra arguments to pass to the nested action (deprecated, use `input-*` instead) | No | |
164172

165173
## Outputs

action.yml

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
name: "TestifySec Action Wrapper with Witness"
2-
description: "Downloads and executes another GitHub Action with Witness attestation"
2+
description: "Downloads and executes another GitHub Action or direct command with Witness attestation for supply chain security"
33
inputs:
4-
# Action or Command
4+
# Action or Command (one is required)
55
action-ref:
6-
description: "Reference to the nested action (e.g., owner/repo@ref)"
6+
description: "Reference to the nested action (e.g., owner/repo@ref or owner/repo@v1)"
77
required: false
88
command:
99
description: "Command to run with Witness (use this or action-ref)"
@@ -108,9 +108,9 @@ inputs:
108108
description: "Path to Maven POM file"
109109
required: false
110110

111-
# For backward compatibility - will pass these to the nested action
111+
# Input Passing to Nested Actions
112112
input-*:
113-
description: "Any input with the prefix 'input-' will be passed to the nested action"
113+
description: "Any input with the prefix 'input-' will be passed to the nested action without the prefix (e.g., input-who-to-greet becomes who-to-greet)"
114114
required: false
115115
extra-args:
116116
description: "Extra arguments to pass to the nested action (deprecated, use input-* instead)"
@@ -122,3 +122,7 @@ outputs:
122122
runs:
123123
using: "node16"
124124
main: "index.js"
125+
126+
branding:
127+
icon: 'lock'
128+
color: 'blue'

0 commit comments

Comments
 (0)