Merge pull request #1170 from crazy-max/rename-summary-disable

rename DOCKER_BUILD_NO_SUMMARY to DOCKER_BUILD_SUMMARY_DISABLE
docker · Jul 2, 2024 · aabbd3f · aabbd3f
2 parents 709dde2 + 9c7c277
commit aabbd3f
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 5 deletions.
diff --git 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
@@ -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/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git 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);