shipgate 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +61 -0
- package/dist/cli.cjs +55338 -35364
- package/package.json +126 -108
- package/scripts/postinstall.js +20 -0
package/README.md
CHANGED
|
@@ -115,6 +115,67 @@ npx shipgate gate specs/
|
|
|
115
115
|
npx shipgate gate --ci --output json
|
|
116
116
|
```
|
|
117
117
|
|
|
118
|
+
### `shipgate proof badge <bundle-path>`
|
|
119
|
+
|
|
120
|
+
Generate a badge (SVG or URL) from a proof bundle for display in README or CI.
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
# Generate SVG badge
|
|
124
|
+
npx shipgate proof badge ./proof-bundle -o badge.svg
|
|
125
|
+
|
|
126
|
+
# Generate badge URL
|
|
127
|
+
npx shipgate proof badge ./proof-bundle --format url --bundle-url https://example.com/bundle
|
|
128
|
+
|
|
129
|
+
# With custom badge service
|
|
130
|
+
npx shipgate proof badge ./proof-bundle --format url --badge-url-base https://badges.example.com
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
The badge displays the proof verdict (PROVEN, INCOMPLETE, VIOLATED, UNPROVEN) with color coding:
|
|
134
|
+
- 🟢 **PROVEN** - Green badge
|
|
135
|
+
- 🟡 **INCOMPLETE_PROOF** - Yellow badge
|
|
136
|
+
- 🔴 **VIOLATED** - Red badge
|
|
137
|
+
- ⚪ **UNPROVEN** - Grey badge
|
|
138
|
+
|
|
139
|
+
### `shipgate proof attest <bundle-path>`
|
|
140
|
+
|
|
141
|
+
Generate SLSA-style attestation JSON from a proof bundle for supply chain security.
|
|
142
|
+
|
|
143
|
+
```bash
|
|
144
|
+
# Output to stdout
|
|
145
|
+
npx shipgate proof attest ./proof-bundle
|
|
146
|
+
|
|
147
|
+
# Save to file
|
|
148
|
+
npx shipgate proof attest ./proof-bundle -o attestation.json
|
|
149
|
+
|
|
150
|
+
# Include full manifest
|
|
151
|
+
npx shipgate proof attest ./proof-bundle --include-manifest -o attestation.json
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
The attestation includes:
|
|
155
|
+
- Verdict and reason
|
|
156
|
+
- Spec information (domain, version, hash)
|
|
157
|
+
- Gate, build, and test results
|
|
158
|
+
- Toolchain versions
|
|
159
|
+
- Bundle fingerprint
|
|
160
|
+
|
|
161
|
+
### `shipgate proof comment <bundle-path>`
|
|
162
|
+
|
|
163
|
+
Generate GitHub PR comment from a proof bundle.
|
|
164
|
+
|
|
165
|
+
```bash
|
|
166
|
+
# Output to stdout (for GitHub Actions)
|
|
167
|
+
npx shipgate proof comment ./proof-bundle
|
|
168
|
+
|
|
169
|
+
# Save to file
|
|
170
|
+
npx shipgate proof comment ./proof-bundle -o pr-comment.md
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
The comment includes:
|
|
174
|
+
- Verdict summary with emoji indicators
|
|
175
|
+
- Phase-by-phase breakdown (Gate, Build, Tests, Verify)
|
|
176
|
+
- Spec and toolchain information
|
|
177
|
+
- Bundle ID and generation timestamp
|
|
178
|
+
|
|
118
179
|
### `shipgate repl`
|
|
119
180
|
|
|
120
181
|
Start an interactive REPL for exploring ISL.
|