You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- 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
Copy file name to clipboardExpand all lines: README.md
+11-3Lines changed: 11 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# TestifySec Action Wrapper with Witness
2
2
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.
4
4
5
5
## Usage
6
6
@@ -67,6 +67,14 @@ This action combines the functionality of a GitHub Action wrapper with Witness a
67
67
3. **Runs with Attestation**: The action is executed through Witness, which creates attestations
68
68
4. **Stores Results**: Attestations are stored (optionally in Archivista) and GitOIDs are returned
69
69
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
+
70
78
## Key Features
71
79
72
80
- **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
90
98
91
99
| Input | Description | Required | Default |
92
100
|-------|-------------|----------|---------|
93
-
| `witness-version` | Version of Witness to use | No | `0.2.11` |
101
+
| `witness-version` | Version of Witness to use | No | `0.8.1` |
94
102
| `witness-install-dir` | Directory to install Witness | No | `./` |
95
103
96
104
### Witness Core Options
@@ -159,7 +167,7 @@ This action combines the functionality of a GitHub Action wrapper with Witness a
159
167
160
168
| Input | Description | Required | Default |
161
169
|-------|-------------|----------|---------|
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 | |
163
171
| `extra-args` | Extra arguments to pass to the nested action (deprecated, use `input-*` instead) | No | |
Copy file name to clipboardExpand all lines: action.yml
+9-5Lines changed: 9 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
1
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"
3
3
inputs:
4
-
# Action or Command
4
+
# Action or Command (one is required)
5
5
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)"
7
7
required: false
8
8
command:
9
9
description: "Command to run with Witness (use this or action-ref)"
@@ -108,9 +108,9 @@ inputs:
108
108
description: "Path to Maven POM file"
109
109
required: false
110
110
111
-
#For backward compatibility - will pass these to the nested action
111
+
#Input Passing to Nested Actions
112
112
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)"
114
114
required: false
115
115
extra-args:
116
116
description: "Extra arguments to pass to the nested action (deprecated, use input-* instead)"
0 commit comments