rename DOCKER_BUILD_EXPORT_RETENTION_DAYS to DOCKER_BUILD_RECORD_RETENTION_DAYS

Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>
This commit is contained in:
CrazyMax 2024-07-02 18:09:36 +02:00
parent de2365af33
commit 11c2faaa9e
No known key found for this signature in database
GPG key ID: ADE44D8C9D44FBE4
3 changed files with 16 additions and 9 deletions

View file

@ -1435,7 +1435,7 @@ jobs:
env: env:
DOCKER_BUILD_RECORD_UPLOAD: false DOCKER_BUILD_RECORD_UPLOAD: false
export-retention-days: record-retention-days:
runs-on: ubuntu-latest runs-on: ubuntu-latest
strategy: strategy:
fail-fast: false fail-fast: false
@ -1462,4 +1462,4 @@ jobs:
with: with:
file: ./test/Dockerfile file: ./test/Dockerfile
env: env:
DOCKER_BUILD_EXPORT_RETENTION_DAYS: ${{ matrix.days }} DOCKER_BUILD_RECORD_RETENTION_DAYS: ${{ matrix.days }}

View file

@ -260,7 +260,7 @@ The following outputs are available:
|--------------------------------------|--------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |--------------------------------------|--------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `DOCKER_BUILD_SUMMARY` | Bool | `true` | If `false`, [build summary](https://docs.docker.com/build/ci/github-actions/build-summary/) generation is disabled | | `DOCKER_BUILD_SUMMARY` | Bool | `true` | If `false`, [build summary](https://docs.docker.com/build/ci/github-actions/build-summary/) generation is disabled |
| `DOCKER_BUILD_RECORD_UPLOAD` | Bool | `true` | If `false`, build record upload as [GitHub artifact](https://docs.github.com/en/actions/using-workflows/storing-workflow-data-as-artifacts) is disabled | | `DOCKER_BUILD_RECORD_UPLOAD` | Bool | `true` | If `false`, build record upload as [GitHub artifact](https://docs.github.com/en/actions/using-workflows/storing-workflow-data-as-artifacts) is disabled |
| `DOCKER_BUILD_EXPORT_RETENTION_DAYS` | Number | | Duration after which build export artifact will expire in days. Defaults to repository/org [retention settings](https://docs.github.com/en/actions/learn-github-actions/usage-limits-billing-and-administration#artifact-and-log-retention-policy) if unset or `0` | | `DOCKER_BUILD_RECORD_RETENTION_DAYS` | Number | | Duration after which build record artifact will expire in days. Defaults to repository/org [retention settings](https://docs.github.com/en/actions/learn-github-actions/usage-limits-billing-and-administration#artifact-and-log-retention-policy) if unset or `0` |
## Troubleshooting ## Troubleshooting

View file

@ -165,9 +165,9 @@ actionsToolkit.run(
await core.group(`Generating build summary`, async () => { await core.group(`Generating build summary`, async () => {
try { try {
const recordUploadEnabled = buildRecordUploadEnabled(); const recordUploadEnabled = buildRecordUploadEnabled();
let exportRetentionDays: number | undefined; let recordRetentionDays: number | undefined;
if (recordUploadEnabled) { if (recordUploadEnabled) {
exportRetentionDays = buildExportRetentionDays(); recordRetentionDays = buildRecordRetentionDays();
} }
const buildxHistory = new BuildxHistory(); const buildxHistory = new BuildxHistory();
@ -181,7 +181,7 @@ actionsToolkit.run(
uploadRes = await GitHub.uploadArtifact({ uploadRes = await GitHub.uploadArtifact({
filename: exportRes.dockerbuildFilename, filename: exportRes.dockerbuildFilename,
mimeType: 'application/gzip', mimeType: 'application/gzip',
retentionDays: exportRetentionDays retentionDays: recordRetentionDays
}); });
} }
@ -239,11 +239,18 @@ function buildRecordUploadEnabled(): boolean {
return true; return true;
} }
function buildExportRetentionDays(): number | undefined { function buildRecordRetentionDays(): number | undefined {
let val: string | undefined;
if (process.env.DOCKER_BUILD_EXPORT_RETENTION_DAYS) { if (process.env.DOCKER_BUILD_EXPORT_RETENTION_DAYS) {
const res = parseInt(process.env.DOCKER_BUILD_EXPORT_RETENTION_DAYS); core.warning('DOCKER_BUILD_EXPORT_RETENTION_DAYS is deprecated. Use DOCKER_BUILD_RECORD_RETENTION_DAYS instead.');
val = process.env.DOCKER_BUILD_EXPORT_RETENTION_DAYS;
} else if (process.env.DOCKER_BUILD_RECORD_RETENTION_DAYS) {
val = process.env.DOCKER_BUILD_RECORD_RETENTION_DAYS;
}
if (val) {
const res = parseInt(val);
if (isNaN(res)) { if (isNaN(res)) {
throw Error(`Invalid build export retention days: ${process.env.DOCKER_BUILD_EXPORT_RETENTION_DAYS}`); throw Error(`Invalid build record retention days: ${val}`);
} }
return res; return res;
} }