Skip to content

Commit 2ee469f

Browse files
committed
Update readme, plugin.yml
1 parent 882ba69 commit 2ee469f

2 files changed

Lines changed: 30 additions & 0 deletions

File tree

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -309,6 +309,34 @@ steps:
309309

310310
The plugin automatically retries binary downloads up to 3 times with a 5-second delay between attempts. This handles transient network issues when downloading from GitHub.
311311

312+
### `verify_checksum` (optional)
313+
314+
Default: `false`
315+
316+
Enable SHA256 checksum verification for downloaded binaries to enhance security. When enabled, the plugin verifies checksums against those published in the GitHub release, providing protection against compromised artifacts, network attacks, and binary tampering.
317+
318+
Checksum verification is performed for:
319+
- Newly downloaded binaries (fails and deletes binary on mismatch)
320+
- Cached binaries before reuse (automatically re-downloads on mismatch)
321+
- Pre-installed binaries when `download: false` (best-effort, non-blocking)
322+
323+
To enable checksum verification:
324+
325+
```yaml
326+
steps:
327+
- label: "Triggering pipelines"
328+
plugins:
329+
- monorepo-diff#v1.8.0:
330+
verify_checksum: true # Recommended for enhanced security
331+
diff: "git diff --name-only HEAD~1"
332+
watch:
333+
- path: "foo-service/"
334+
config:
335+
trigger: "deploy-foo-service"
336+
```
337+
338+
If checksums are unavailable for a release or the SHA256 command is not found on the system, the plugin will warn but continue execution (graceful degradation).
339+
312340
### `hooks` (optional)
313341

314342
Currently supports a list of `commands` you wish to execute after the `watched` pipelines have been triggered

plugin.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ configuration:
99
type: string
1010
download:
1111
type: boolean
12+
verify_checksum:
13+
type: boolean
1214
log_level:
1315
type: string
1416
interpolation:

0 commit comments

Comments
 (0)