forked from open-component-model/open-component-model
-
Notifications
You must be signed in to change notification settings - Fork 0
423 lines (385 loc) · 16.8 KB
/
cli-release.yml
File metadata and controls
423 lines (385 loc) · 16.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
name: CLI Release
run-name: CLI Release from ${{ github.event.inputs.branch }}${{ github.event.inputs.dry_run == 'true' && '(dry-run)' || '' }}
on:
workflow_dispatch:
inputs:
branch:
description: "Branch to release from, must match regex releases/v0.[0-9]+"
required: true
type: string
dry_run:
description: "Dry-run RC phase without pushing tags or creating releases."
required: false
default: true
type: boolean
env:
REGISTRY: ghcr.io
COMPONENT_PATH: cli
concurrency:
cancel-in-progress: true
group: cli-release-${{ github.event.inputs.branch }}
jobs:
# ============================================================
# PHASE 1: RELEASE CANDIDATE
# ============================================================
# --------------------------------------------------------
# 1. PREPARE: Compute RC version and generate changelog
# --------------------------------------------------------
prepare:
name: Prepare Release Metadata
uses: ./.github/workflows/release-candidate-version.yml
with:
branch: ${{ github.event.inputs.branch }}
component_path: cli # cannot use env here
secrets: inherit
# --------------------------------------------------------
# 2. TAG RC: Create and push RC tag (skipped on dry-run)
# --------------------------------------------------------
tag_rc:
name: Create and Push RC Tag
runs-on: ubuntu-latest
needs: [prepare]
if: ${{ github.event.inputs.dry_run == 'false' }}
permissions:
contents: write
outputs:
pushed: ${{ steps.tag.outputs.pushed }}
steps:
- name: Generate App Token
id: get_token
uses: actions/create-github-app-token@29824e69f54612133e76f7eaac726eef6c875baf # v2.2.1
with:
app-id: ${{ secrets.OCMBOT_APP_ID }}
private-key: ${{ secrets.OCMBOT_PRIV_KEY }}
- name: Checkout Repository
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
with:
sparse-checkout: ${{ env.COMPONENT_PATH }}
ref: ${{ github.event.inputs.branch }}
token: ${{ steps.get_token.outputs.token }}
- name: Setup git config
run: |
git config --global user.name "${{ github.actor }}"
git config --global user.email "${{ github.actor }}@users.noreply.github.com"
- name: Create tag
id: tag
uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8
env:
TAG: ${{ needs.prepare.outputs.new_tag }}
CHANGELOG_B64: ${{ needs.prepare.outputs.changelog_b64 }}
with:
github-token: ${{ steps.get_token.outputs.token }}
script: |
const { execFileSync } = require("child_process");
const tag = process.env.TAG;
const msg = Buffer.from(process.env.CHANGELOG_B64, "base64").toString("utf8");
try { execFileSync("git", ["rev-parse", `refs/tags/${tag}`], { stdio: "pipe" }); core.info(`Tag ${tag} exists`); core.setOutput("pushed","false"); return; } catch {}
require("fs").writeFileSync(".tagmsg", msg);
execFileSync("git", ["tag", "-a", tag, "-F", ".tagmsg"]);
execFileSync("git", ["push", "origin", `refs/tags/${tag}`]);
core.setOutput("pushed","true");
core.info(`✅ Created RC tag ${tag}`);
# --------------------------------------------------------
# 3. BUILD CLI
# --------------------------------------------------------
build:
name: Build CLI for ${{ needs.prepare.outputs.new_tag }}
if: ${{ github.event.inputs.dry_run == 'false' && needs.tag_rc.outputs.pushed == 'true' }}
needs: [prepare, tag_rc]
uses: ./.github/workflows/cli.yml
secrets: inherit
with:
ref: ${{ needs.prepare.outputs.new_tag }}
# --------------------------------------------------------
# 4. RELEASE RC: Create GitHub pre-release
# --------------------------------------------------------
release_rc:
name: Create RC Pre-Release
if: ${{ github.event.inputs.dry_run == 'false' && needs.tag_rc.outputs.pushed == 'true' }}
needs: [prepare, tag_rc, build]
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Decode changelog
env:
CHANGELOG_B64: ${{ needs.prepare.outputs.changelog_b64 }}
run: echo "$CHANGELOG_B64" | base64 --decode > "${{ runner.temp }}/CHANGELOG.md"
- name: Download CLI artifacts
uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
repository: ${{ github.repository }}
name: ${{ needs.build.outputs.artifact_name }}
path: ${{ runner.temp }}/rc-build-assets
- name: Create RC Release
uses: softprops/action-gh-release@a06a81a03ee405af7f2048a818ed3f03bbf83c7b # v2
with:
name: CLI ${{ needs.prepare.outputs.new_version }}
tag_name: ${{ needs.prepare.outputs.new_tag }}
body_path: ${{ runner.temp }}/CHANGELOG.md
fail_on_unmatched_files: true
prerelease: true
files: |
${{ runner.temp }}/rc-build-assets/bin/ocm-*
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Summarize RC release
uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8
env:
RC_TAG: ${{ needs.prepare.outputs.new_tag }}
RC_VERSION: ${{ needs.prepare.outputs.new_version }}
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
script: |
const release = await github.rest.repos.getReleaseByTag({
owner: context.repo.owner,
repo: context.repo.repo,
tag: process.env.RC_TAG,
});
const releaseUrl = release.data.html_url;
const assetsCount = Array.isArray(release.data.assets) ? release.data.assets.length : 0;
await core.summary
.addHeading('RC Release Published')
.addTable([
[{ data: 'Field', header: true }, { data: 'Value', header: true }],
['RC Tag', process.env.RC_TAG],
['RC Version', process.env.RC_VERSION],
['Uploaded Assets', String(assetsCount)],
])
.addEOL()
.addLink(releaseUrl, releaseUrl)
.addEOL()
.write();
# ================================================
# PHASE 2: FINAL RELEASE (after environment gate)
# ================================================
# Environment Gate:
# The "cli/release" environment must be configured in GitHub Settings → Environments:
# - Required reviewers: At least 1 reviewer must approve
# - Wait timer: 20160 minutes (14 days)
#
# This gate blocks all Phase 2 jobs until approved.
# -----------------------------------------------------------
# 5. VERIFY ATTESTATIONS: Ensure RC artifacts are attestable
# -----------------------------------------------------------
verify_attestations:
name: Verify RC Attestations
needs: [prepare, build, release_rc]
runs-on: ubuntu-latest
environment:
name: cli/release
permissions:
contents: read
packages: read
steps:
- name: Download RC binaries
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
RC_TAG: ${{ needs.prepare.outputs.new_tag }}
run: |
gh release download "$RC_TAG" \
--repo "${{ github.repository }}" \
--pattern "ocm-*" \
--dir "${{ runner.temp }}/binaries"
- name: Verify binary attestations
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
for file in ${{ runner.temp }}/binaries/ocm-*; do
echo "Verifying $(basename "$file")..."
gh attestation verify "$file" --repo "${{ github.repository }}"
done
echo "✅ All binary attestations verified"
- name: Verify OCI image attestation
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
IMAGE_DIGEST: ${{ needs.build.outputs.image_digest }}
TARGET_REPO: ${{ env.REGISTRY }}/${{ github.repository_owner }}/cli
run: |
echo "Verifying OCI image attestation for ${TARGET_REPO}@${IMAGE_DIGEST}..."
gh attestation verify "oci://${TARGET_REPO}@${IMAGE_DIGEST}" --repo "${{ github.repository }}"
echo "✅ OCI image attestation verified"
# ---------------------------------------------------------
# 6. PROMOTE FINAL: Create final tag and promote OCI image
# ---------------------------------------------------------
promote_final:
name: Promote to Final Release
needs: [prepare, build, verify_attestations]
runs-on: ubuntu-latest
permissions:
contents: write
packages: write
steps:
- name: Generate App Token
id: get_token
uses: actions/create-github-app-token@29824e69f54612133e76f7eaac726eef6c875baf # v2.2.1
with:
app-id: ${{ secrets.OCMBOT_APP_ID }}
private-key: ${{ secrets.OCMBOT_PRIV_KEY }}
- name: Checkout
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
with:
sparse-checkout: ${{ env.COMPONENT_PATH }}
fetch-depth: 0
ref: ${{ github.event.inputs.branch }}
token: ${{ steps.get_token.outputs.token }}
- name: Setup git config
run: |
git config --global user.name "${{ github.actor }}"
git config --global user.email "${{ github.actor }}@users.noreply.github.com"
- name: Create final tag
# Points final tag to same commit as RC tag (no rebuild needed)
uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8
env:
RC_TAG: ${{ needs.prepare.outputs.new_tag }}
FINAL_TAG: ${{ needs.prepare.outputs.promotion_tag }}
with:
github-token: ${{ steps.get_token.outputs.token }}
script: |
const { execFileSync } = require("child_process");
const { RC_TAG: rcTag, FINAL_TAG: finalTag } = process.env;
try {
execFileSync("git", ["rev-parse", `refs/tags/${finalTag}`], { stdio: "pipe" });
core.setFailed(`Tag ${finalTag} already exists`);
return;
} catch {}
const rcSha = execFileSync("git", ["rev-parse", `refs/tags/${rcTag}^{commit}`], { stdio: "pipe" }).toString().trim();
execFileSync("git", ["tag", "-a", finalTag, rcSha, "-m", `Promote ${rcTag} to ${finalTag}`]);
execFileSync("git", ["push", "origin", `refs/tags/${finalTag}`]);
core.info(`✅ Created final tag ${finalTag} from ${rcTag} (${rcSha.substring(0,7)})`);
- name: Setup ORAS
uses: oras-project/setup-oras@22ce207df3b08e061f537244349aac6ae1d214f6 # v1
- name: Log in to GHCR
uses: docker/login-action@c94ce9fb468520275223c153574b00df6fe4bcc9 # v3
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Promote OCI image tags
env:
RC_VERSION: ${{ needs.prepare.outputs.new_version }}
FINAL_VERSION: ${{ needs.prepare.outputs.promotion_version }}
TARGET_REPO: ${{ env.REGISTRY }}/${{ github.repository_owner }}/cli
SET_LATEST: ${{ needs.prepare.outputs.set_latest }}
run: |
if [ "$SET_LATEST" = "true" ]; then
oras tag "${TARGET_REPO}:${RC_VERSION}" "${FINAL_VERSION}" "latest"
echo "✅ Tagged :${FINAL_VERSION} and :latest"
else
oras tag "${TARGET_REPO}:${RC_VERSION}" "${FINAL_VERSION}"
echo "⚠️ Tagged :${FINAL_VERSION} (not setting :latest)"
fi
# --------------------------------------------------------
# 7. RELEASE FINAL: Create GitHub final release
# --------------------------------------------------------
release_final:
name: Create Final Release
needs: [prepare, promote_final]
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Get release notes from RC
# Get release notes from RC release body to reuse for final release
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
RC_TAG: ${{ needs.prepare.outputs.new_tag }}
run: |
gh release view "$RC_TAG" \
--repo "${{ github.repository }}" \
--json body \
--jq '.body' > "${{ runner.temp }}/CHANGELOG.md"
- name: Download RC release binaries
# Download binaries from RC release assets to reuse for final release
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
RC_TAG: ${{ needs.prepare.outputs.new_tag }}
run: |
gh release download "$RC_TAG" \
--repo "${{ github.repository }}" \
--pattern "ocm-*" \
--dir "${{ runner.temp }}/binaries"
- name: Publish final release
uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8
env:
RC_TAG: ${{ needs.prepare.outputs.new_tag }}
FINAL_TAG: ${{ needs.prepare.outputs.promotion_tag }}
FINAL_VERSION: ${{ needs.prepare.outputs.promotion_version }}
TARGET_REPO: ${{ env.REGISTRY }}/${{ github.repository_owner }}/cli
BINARIES_DIR: ${{ runner.temp }}/binaries
NOTES_FILE: ${{ runner.temp }}/CHANGELOG.md
SET_LATEST: ${{ needs.prepare.outputs.set_latest }}
HIGHEST_FINAL_VERSION: ${{ needs.prepare.outputs.highest_final_version }}
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
script: |
const fs = require('fs');
const path = require('path');
const finalTag = process.env.FINAL_TAG;
const finalVersion = process.env.FINAL_VERSION;
const rcTag = process.env.RC_TAG;
const targetRepo = process.env.TARGET_REPO;
const binariesDir = process.env.BINARIES_DIR;
const notesFile = process.env.NOTES_FILE;
const setLatest = process.env.SET_LATEST === 'true';
let notes = fs.existsSync(notesFile)
? fs.readFileSync(notesFile, 'utf8').trim()
: `Promoted from ${rcTag}`;
// Replace RC header with final release header
// From: "[cli/v0.17.0-rc.1] - 2026-02-02"
// To: "[cli/v0.17.0] - promoted from [cli/v0.17.0-rc.1] on 2026-02-16"
const today = new Date().toISOString().split('T')[0];
notes = notes.replace(
/^\[([^\]]+)\]\s*-\s*[\d-]+/,
`[${finalTag}] - promoted from [${rcTag}] on ${today}`
);
// Use make_latest to control whether this release is marked as "latest"
// Only set as latest if this version >= highest existing final version
const created = await github.rest.repos.createRelease({
owner: context.repo.owner,
repo: context.repo.repo,
tag_name: finalTag,
name: `CLI ${finalVersion}`,
body: notes,
prerelease: false,
make_latest: setLatest ? 'true' : 'false',
});
core.info(setLatest
? `✅ Release marked as Latest`
: `⚠️ Release NOT marked as Latest (older patch release)`);
// Upload binaries from RC release
const binaries = fs.readdirSync(binariesDir).filter(f => f.startsWith('ocm-'));
for (const file of binaries) {
const filePath = path.join(binariesDir, file);
const data = fs.readFileSync(filePath);
await github.rest.repos.uploadReleaseAsset({
owner: context.repo.owner,
repo: context.repo.repo,
release_id: created.data.id,
name: file,
data,
headers: {
'content-type': 'application/octet-stream',
},
});
}
const releaseUrl = created.data.html_url;
const highestFinal = process.env.HIGHEST_FINAL_VERSION || '(none)';
const ociTags = setLatest
? `${targetRepo}:${finalVersion}, ${targetRepo}:latest`
: `${targetRepo}:${finalVersion}`;
await core.summary
.addHeading('Final Release Published')
.addTable([
[{data: 'Field', header: true}, {data: 'Value', header: true}],
['Final Tag', finalTag],
['Promoted from RC', rcTag],
['Highest Final Version', highestFinal],
['OCI Tags', ociTags],
['GitHub Latest', setLatest ? 'Yes' : 'No (older version)'],
])
.addEOL()
.addLink(releaseUrl, releaseUrl)
.addEOL()
.write();