Skip to content

Commit a528d88

Browse files
authored
enhance documentation with pros and cons of actions
Added pros and cons for source-based and prebuilt GitHub Actions.
1 parent d9ec07b commit a528d88

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

docs/github_action.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,10 @@ The `go-test-coverage` project provides two types of GitHub Actions:
176176
uses: vladopajic/go-test-coverage@v2
177177
with: ...
178178
```
179+
Pros/Cons:
180+
- Generally faster in practice because everything is packaged and prebuilt.
181+
- Does not require any additional dependencies on the CI runner.
182+
- However, **it introduces a potential supply-chain risk**: using a prebuilt container image means you must trust that the image is safe and has not been tampered with. This repository has no intention of introducing malicious code, but projects with stricter security requirements may still prefer to avoid running opaque binaries.
179183

180184
- **Source-based Action (optional/experimental)**
181185

@@ -188,9 +192,17 @@ The `go-test-coverage` project provides two types of GitHub Actions:
188192
uses: vladopajic/go-test-coverage/action/source@v2
189193
with: ...
190194
```
191-
Note: this action requires `go` to be installed.
195+
Pros/Cons:
196+
- Requires `go` to be installed on the CI runner.
197+
- Slightly slower, as dependencies need to be fetched and the binary built during the workflow.
198+
- The main **advantage is transparency and auditability**: the action runs exactly the code in this repository, which can be reviewed and pinned to a specific version. This can be preferable for environments with strong security or compliance requirements.
199+
200+
Both actions have the same inputs, so they can be used interchangeably.
201+
202+
203+
204+
192205

193-
Both actions have the same inputs, so they can be used interchangeably.
194206

195207

196208

0 commit comments

Comments
 (0)