-
Notifications
You must be signed in to change notification settings - Fork 0
317 lines (282 loc) · 13 KB
/
cleanup-ghcr-images.yml
File metadata and controls
317 lines (282 loc) · 13 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
name: Cleanup GHCR Images
on:
schedule:
- cron: '0 3 * * *'
workflow_dispatch:
inputs:
images_to_keep:
description: Maximum number of tagged images to keep (high water mark, 0 = no limit)
required: false
default: '4'
retention_days:
description: Delete images older than this many days (0 = no age limit)
required: false
default: '15'
delete_unversioned:
description: Delete unversioned images (SHA-only or untagged)
required: false
type: boolean
default: true
dry_run:
description: Log deletions without removing image versions
required: false
type: boolean
default: true
permissions:
packages: write
env:
PACKAGE_NAME: opencode-cli
IMAGES_TO_KEEP: ${{ inputs.images_to_keep || vars.GHCR_IMAGES_TO_KEEP }}
RETENTION_DAYS: ${{ inputs.retention_days || vars.GHCR_RETENTION_DAYS }}
DELETE_UNVERSIONED: ${{ github.event_name == 'workflow_dispatch' && inputs.delete_unversioned || vars.GHCR_DELETE_UNVERSIONED || 'true' }}
DRY_RUN: ${{ github.event_name == 'workflow_dispatch' && inputs.dry_run || 'false' }}
jobs:
cleanup:
runs-on: ubuntu-latest
steps:
- name: Cleanup container versions
id: cleanup
uses: actions/github-script@v9
env:
PACKAGE_NAME: ${{ env.PACKAGE_NAME }}
IMAGES_TO_KEEP: ${{ env.IMAGES_TO_KEEP }}
RETENTION_DAYS: ${{ env.RETENTION_DAYS }}
DELETE_UNVERSIONED: ${{ env.DELETE_UNVERSIONED }}
DRY_RUN: ${{ env.DRY_RUN }}
with:
result-encoding: string
script: |
const owner = context.repo.owner;
const packageType = 'container';
const packageName = process.env.PACKAGE_NAME;
const imagesToKeep = Number(process.env.IMAGES_TO_KEEP || 0);
const retentionDays = Number(process.env.RETENTION_DAYS || 0);
const deleteUnversioned = process.env.DELETE_UNVERSIONED === 'true';
const dryRun = process.env.DRY_RUN === 'true';
const cutoff = retentionDays > 0 ? new Date(Date.now() - retentionDays * 24 * 60 * 60 * 1000) : null;
if (!Number.isFinite(imagesToKeep) || imagesToKeep < 0) {
throw new Error(`IMAGES_TO_KEEP must be a non-negative number, received: ${process.env.IMAGES_TO_KEEP}`);
}
if (!Number.isFinite(retentionDays) || retentionDays < 0) {
throw new Error(`RETENTION_DAYS must be a non-negative number, received: ${process.env.RETENTION_DAYS}`);
}
const paginateVersions = async () => {
try {
return {
scope: 'org',
versions: await github.paginate(
github.rest.packages.getAllPackageVersionsForPackageOwnedByOrg,
{
package_type: packageType,
package_name: packageName,
org: owner,
per_page: 100,
},
),
};
} catch (error) {
if (error.status !== 404) {
throw error;
}
return {
scope: 'user',
versions: await github.paginate(
github.rest.packages.getAllPackageVersionsForPackageOwnedByUser,
{
package_type: packageType,
package_name: packageName,
username: owner,
per_page: 100,
},
),
};
}
};
const deleteVersion = async (scope, versionId) => {
if (scope === 'org') {
await github.rest.packages.deletePackageVersionForOrg({
package_type: packageType,
package_name: packageName,
org: owner,
package_version_id: versionId,
});
return;
}
await github.rest.packages.deletePackageVersionForUser({
package_type: packageType,
package_name: packageName,
username: owner,
package_version_id: versionId,
});
};
const isShaTag = (value) => /^sha-[0-9a-f]{7,}$/i.test(value);
const isUnversioned = (version) => {
const tags = version.metadata?.container?.tags ?? [];
return tags.length === 0 || tags.every(isShaTag);
};
const isTagged = (version) => {
const tags = version.metadata?.container?.tags ?? [];
return tags.length > 0 && !tags.every(isShaTag);
};
// Semantic version handling
const specialTags = new Set(['latest', 'stable', 'next', 'canary', 'edge', 'dev', 'alpha', 'beta', 'rc', 'release']);
const semverPattern = /^v?(\d+)(?:\.(\d+))?(?:\.(\d+))?(?:[-._]?(.+))?$/;
const parseSemver = (tag) => {
const match = tag.match(semverPattern);
if (!match) return null;
return {
major: parseInt(match[1], 10),
minor: match[2] !== undefined ? parseInt(match[2], 10) : 0,
patch: match[3] !== undefined ? parseInt(match[3], 10) : 0,
prerelease: match[4] || null,
original: tag
};
};
const compareSemver = (a, b) => {
if (a.major !== b.major) return a.major - b.major;
if (a.minor !== b.minor) return a.minor - b.minor;
if (a.patch !== b.patch) return a.patch - b.patch;
if (a.prerelease && !b.prerelease) return -1;
if (!a.prerelease && b.prerelease) return 1;
if (a.prerelease && b.prerelease) return a.prerelease.localeCompare(b.prerelease);
return 0;
};
const extractSemver = (version) => {
const tags = version.metadata?.container?.tags ?? [];
const semverTags = tags
.filter(tag => !isShaTag(tag) && !specialTags.has(tag.toLowerCase()))
.map(parseSemver)
.filter(Boolean)
.sort((a, b) => compareSemver(b, a));
return semverTags[0] || null;
};
const { scope, versions } = await paginateVersions();
core.info(`Found ${versions.length} total versions`);
// Sort by semantic version DESC, then by updated_at DESC as tiebreaker
const sortedVersions = [...versions].sort((left, right) => {
const leftSemver = extractSemver(left);
const rightSemver = extractSemver(right);
if (leftSemver && rightSemver) {
const cmp = compareSemver(rightSemver, leftSemver);
if (cmp !== 0) return cmp;
} else if (leftSemver && !rightSemver) {
return -1;
} else if (!leftSemver && rightSemver) {
return 1;
}
return new Date(right.updated_at) - new Date(left.updated_at);
});
// Separate unversioned (SHA-only or untagged) from properly tagged versions
const unversionedVersions = sortedVersions.filter(isUnversioned);
const taggedVersions = sortedVersions.filter(isTagged);
core.info(`${unversionedVersions.length} unversioned versions (SHA-only or untagged)`);
core.info(`${taggedVersions.length} tagged versions to evaluate for retention`);
// Apply retention filter to tagged versions
let candidates = taggedVersions;
if (retentionDays > 0) {
candidates = taggedVersions.filter(v => new Date(v.updated_at) >= cutoff);
core.info(`Retention filter: ${candidates.length} of ${taggedVersions.length} versions within ${retentionDays} days`);
}
// Apply count cap
if (imagesToKeep > 0 && candidates.length > imagesToKeep) {
candidates = candidates.slice(0, imagesToKeep);
core.info(`Count cap: limiting to ${imagesToKeep} newest versions`);
}
// Safety: ensure at least 1 tagged image
if (candidates.length === 0 && taggedVersions.length > 0) {
candidates.push(taggedVersions[0]);
core.info(`Safety: added newest tagged version ${taggedVersions[0].id} to ensure minimum of 1 tagged image`);
}
// Build set of IDs to keep
const keepIds = new Set(candidates.map(v => v.id));
core.info(`Will keep ${keepIds.size} tagged versions`);
// Process all versions
let unversionedDeleted = 0;
let ageBasedDeleted = 0;
let retainedCount = 0;
core.info('');
core.info('=== Unversioned (SHA-only or untagged) ===');
if (unversionedVersions.length === 0) {
core.info('None found.');
} else if (deleteUnversioned) {
for (const version of unversionedVersions) {
const tags = version.metadata?.container?.tags ?? [];
core.info(`${dryRun ? '[DRY RUN] Would delete' : 'Deleting'} unversioned version ${version.id} with tags: ${tags.join(', ') || '(none)'}`);
if (!dryRun) {
await deleteVersion(scope, version.id);
}
unversionedDeleted += 1;
}
} else {
for (const version of unversionedVersions) {
const tags = version.metadata?.container?.tags ?? [];
core.info(`Keeping unversioned version ${version.id} with tags: ${tags.join(', ') || '(none)'} (DELETE_UNVERSIONED is false)`);
}
}
core.info('');
core.info('=== Tagged versions ===');
for (const version of taggedVersions) {
const tags = version.metadata?.container?.tags ?? [];
if (keepIds.has(version.id)) {
core.info(`Keeping version ${version.id} with tags: ${tags.join(', ')}`);
retainedCount += 1;
} else {
core.info(`${dryRun ? '[DRY RUN] Would delete' : 'Deleting'} version ${version.id} with tags: ${tags.join(', ')}`);
if (!dryRun) {
await deleteVersion(scope, version.id);
}
ageBasedDeleted += 1;
}
}
core.info('');
core.info('=== Summary ===');
if (deleteUnversioned) {
core.info(`Unversioned deleted: ${unversionedDeleted}`);
}
core.info(`Age/count-based deleted: ${ageBasedDeleted}`);
core.info(`Retained: ${retainedCount} (all tagged)`);
return JSON.stringify({
totalBefore: versions.length,
unversionedDeleted,
ageBasedDeleted,
retainedCount,
});
- name: Generate cleanup report
if: always()
uses: actions/github-script@v9
env:
CLEANUP_RESULT: ${{ steps.cleanup.outputs.result }}
DELETE_UNVERSIONED: ${{ env.DELETE_UNVERSIONED }}
DRY_RUN: ${{ env.DRY_RUN }}
IMAGES_TO_KEEP: ${{ env.IMAGES_TO_KEEP }}
RETENTION_DAYS: ${{ env.RETENTION_DAYS }}
with:
script: |
const dryRun = process.env.DRY_RUN === 'true';
const deleteUnversioned = process.env.DELETE_UNVERSIONED === 'true';
const imagesToKeep = process.env.IMAGES_TO_KEEP || '0';
const retentionDays = process.env.RETENTION_DAYS || '0';
let summary = '## 🧹 GHCR Cleanup Report\n\n';
if (dryRun) {
summary += '> ⚠️ **Dry run mode** - no images were actually deleted\n\n';
}
summary += '### Configuration\n';
summary += '| Setting | Value |\n';
summary += '|---------|-------|\n';
summary += `| Images to keep | ${imagesToKeep} |\n`;
summary += `| Retention days | ${retentionDays} |\n`;
summary += `| Delete unversioned | ${deleteUnversioned} |\n\n`;
const result = process.env.CLEANUP_RESULT;
if (result && result !== 'null') {
const data = JSON.parse(result);
summary += '### Summary\n';
summary += '| Metric | Count |\n';
summary += '|--------|-------|\n';
summary += `| Total versions before | ${data.totalBefore || 0} |\n`;
if (deleteUnversioned) {
summary += `| Unversioned deleted | ${data.unversionedDeleted || 0} |\n`;
}
summary += `| Age/count-based deleted | ${data.ageBasedDeleted || 0} |\n`;
summary += `| **Retained tagged images** | **${data.retainedCount || 0}** |\n`;
}
core.summary.addRaw(summary).write();