From 987902144c88016241d89dc13fd74ede80862b71 Mon Sep 17 00:00:00 2001 From: CrazyMax <1951866+crazy-max@users.noreply.github.com> Date: Tue, 2 Jul 2024 14:49:31 +0200 Subject: [PATCH] rename DOCKER_BUILD_NO_SUMMARY to DOCKER_BUILD_SUMMARY_DISABLE Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com> --- .github/workflows/ci.yml | 2 +- README.md | 2 +- src/main.ts | 12 +++++++++++- 3 files changed, 13 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index f00db80..f470fd4 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1366,7 +1366,7 @@ jobs: with: file: ./test/Dockerfile env: - DOCKER_BUILD_NO_SUMMARY: true + DOCKER_BUILD_SUMMARY_DISABLE: true summary-not-supported: runs-on: ubuntu-latest diff --git a/README.md b/README.md index 287dbd8..d0eadf0 100644 --- a/README.md +++ b/README.md @@ -258,7 +258,7 @@ The following outputs are available: | Name | Type | Description | |--------------------------------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `DOCKER_BUILD_NO_SUMMARY` | Bool | If `true`, [build summary](https://docs.docker.com/build/ci/github-actions/build-summary/) generation is disabled | +| `DOCKER_BUILD_SUMMARY_DISABLE` | Bool | If `true`, [build summary](https://docs.docker.com/build/ci/github-actions/build-summary/) generation 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` | ## Troubleshooting diff --git a/src/main.ts b/src/main.ts index 086c058..f2a0a74 100644 --- a/src/main.ts +++ b/src/main.ts @@ -138,7 +138,7 @@ actionsToolkit.run( }); await core.group(`Check build summary support`, async () => { - if (process.env.DOCKER_BUILD_NO_SUMMARY && Util.parseBool(process.env.DOCKER_BUILD_NO_SUMMARY)) { + if (buildSummaryDisabled()) { core.info('Build summary disabled'); } else if (GitHub.isGHES) { core.warning('Build summary is not yet supported on GHES'); @@ -211,6 +211,16 @@ async function buildRef(toolkit: Toolkit, since: Date, builder?: string): Promis return Object.keys(refs).length > 0 ? Object.keys(refs)[0] : ''; } +function buildSummaryDisabled(): boolean { + if (process.env.DOCKER_BUILD_NO_SUMMARY) { + core.warning('DOCKER_BUILD_NO_SUMMARY is deprecated. Use DOCKER_BUILD_SUMMARY_DISABLE instead.'); + return Util.parseBool(process.env.DOCKER_BUILD_NO_SUMMARY); + } else if (process.env.DOCKER_BUILD_SUMMARY_DISABLE) { + return Util.parseBool(process.env.DOCKER_BUILD_SUMMARY_DISABLE); + } + return false; +} + function buildExportRetentionDays(): number | undefined { if (process.env.DOCKER_BUILD_EXPORT_RETENTION_DAYS) { const res = parseInt(process.env.DOCKER_BUILD_EXPORT_RETENTION_DAYS);