Make skip-restore opinionated, drop the restore input

Default-branch builds always skip restore and publish a fresh base bundle.
No setting to override.

Author: joshfriend

README.md

@@ -63,9 +63,6 @@ needed:
   from the **merge-base** of the PR branch and the default branch) and, after
   the build, publish a **delta** containing only the files that changed.
 
-If you need to override the automatic choice, set the `restore` input to
-`"true"` or `"false"` (default is `"auto"`).
-
 ### Inputs
 
 | Input | Default | Description |
@@ -78,7 +75,6 @@ If you need to override the automatic choice, set the `restore` input to
 | `included-build` | | Comma-separated included build paths (e.g. `buildSrc,build-logic`). |
 | `bucket` | | S3 bucket name. When set, uses S3 instead of the GitHub Actions cache. |
 | `region` | `us-west-2` | AWS region (only used with `bucket`). |
-| `restore` | `auto` | Restore before the build. `auto` skips restore on default-branch builds and restores on branches/PRs. Set `true`/`false` to override. |
 | `save` | `true` | Set to `false` to skip saving after the build. |
 | `version` | `latest` | Version of gradle-cache to install. |
 | `log-level` | `info` | Log level: `debug`, `info`, `warn`, or `error`. |

action.yml

@@ -57,14 +57,6 @@ inputs:
       Comma-separated list of included build paths to archive
       (e.g. "buildSrc,build-logic"). Defaults to buildSrc.
     required: false
-  restore:
-    description: >
-      Whether to restore a cache before the build. Defaults to "auto": restore
-      is skipped on default-branch builds (which publish a fresh base bundle so
-      it never grows without bound) and enabled on branches/PRs (which restore
-      the base and publish a delta). Set to "true" or "false" to override.
-    required: false
-    default: "auto"
   save:
     description: Whether to save the cache after the build. Set to "false" to skip.
     required: false

action/src/helpers.js

@@ -163,7 +163,8 @@ function defaultBranch() {
 /**
  * True when this run is a push build of the repository's default branch.
  * These builds publish a fresh full ("base") bundle and never restore, so the
- * bundle doesn't grow without bound across commits.
+ * bundle doesn't grow without bound across commits. Branches and PRs restore
+ * the base and publish a delta.
  */
 function isDefaultBranchBuild() {
   const event = process.env.GITHUB_EVENT_NAME || "";
@@ -175,21 +176,6 @@ function isDefaultBranchBuild() {
   return def !== "HEAD" && refName === def;
 }
 
-/**
- * Decide whether to restore a cache before the build.
- *
- * The `restore` input is an explicit override ("true"/"false"). When left at
- * the default ("auto"), restore is skipped on default-branch builds (which
- * publish a fresh base bundle) and enabled everywhere else (branches/PRs that
- * restore the base and publish a delta).
- */
-function shouldRestore() {
-  const input = (core.getInput("restore") || "auto").toLowerCase();
-  if (input === "false") return false;
-  if (input === "true") return true;
-  return !isDefaultBranchBuild();
-}
-
 module.exports = {
   install,
   backendArgs,
@@ -201,5 +187,4 @@ module.exports = {
   resolveBranch,
   defaultBranch,
   isDefaultBranchBuild,
-  shouldRestore,
 };

action/src/main.js

@@ -9,7 +9,7 @@ const {
   execOptions,
   resolveBranch,
   defaultBranch,
-  shouldRestore,
+  isDefaultBranchBuild,
 } = require("./helpers");
 
 async function run() {
@@ -18,7 +18,7 @@ async function run() {
     core.saveState("cache-key", core.getInput("cache-key"));
     core.saveState("save", core.getInput("save"));
 
-    if (!shouldRestore()) {
+    if (isDefaultBranchBuild()) {
       core.info(
         "Cache restore skipped — default-branch build publishes a fresh base bundle",
       );

dist/main/index.js

@@ -33687,7 +33687,8 @@ function defaultBranch() {
 /**
  * True when this run is a push build of the repository's default branch.
  * These builds publish a fresh full ("base") bundle and never restore, so the
- * bundle doesn't grow without bound across commits.
+ * bundle doesn't grow without bound across commits. Branches and PRs restore
+ * the base and publish a delta.
  */
 function isDefaultBranchBuild() {
   const event = process.env.GITHUB_EVENT_NAME || "";
@@ -33699,21 +33700,6 @@ function isDefaultBranchBuild() {
   return def !== "HEAD" && refName === def;
 }
 
-/**
- * Decide whether to restore a cache before the build.
- *
- * The `restore` input is an explicit override ("true"/"false"). When left at
- * the default ("auto"), restore is skipped on default-branch builds (which
- * publish a fresh base bundle) and enabled everywhere else (branches/PRs that
- * restore the base and publish a delta).
- */
-function shouldRestore() {
-  const input = (core.getInput("restore") || "auto").toLowerCase();
-  if (input === "false") return false;
-  if (input === "true") return true;
-  return !isDefaultBranchBuild();
-}
-
 module.exports = {
   install,
   backendArgs,
@@ -33725,7 +33711,6 @@ module.exports = {
   resolveBranch,
   defaultBranch,
   isDefaultBranchBuild,
-  shouldRestore,
 };
 
 
@@ -34061,7 +34046,7 @@ const {
   execOptions,
   resolveBranch,
   defaultBranch,
-  shouldRestore,
+  isDefaultBranchBuild,
 } = __nccwpck_require__(6636);
 
 async function run() {
@@ -34070,7 +34055,7 @@ async function run() {
     core.saveState("cache-key", core.getInput("cache-key"));
     core.saveState("save", core.getInput("save"));
 
-    if (!shouldRestore()) {
+    if (isDefaultBranchBuild()) {
       core.info(
         "Cache restore skipped — default-branch build publishes a fresh base bundle",
       );

dist/post/index.js

@@ -33687,7 +33687,8 @@ function defaultBranch() {
 /**
  * True when this run is a push build of the repository's default branch.
  * These builds publish a fresh full ("base") bundle and never restore, so the
- * bundle doesn't grow without bound across commits.
+ * bundle doesn't grow without bound across commits. Branches and PRs restore
+ * the base and publish a delta.
  */
 function isDefaultBranchBuild() {
   const event = process.env.GITHUB_EVENT_NAME || "";
@@ -33699,21 +33700,6 @@ function isDefaultBranchBuild() {
   return def !== "HEAD" && refName === def;
 }
 
-/**
- * Decide whether to restore a cache before the build.
- *
- * The `restore` input is an explicit override ("true"/"false"). When left at
- * the default ("auto"), restore is skipped on default-branch builds (which
- * publish a fresh base bundle) and enabled everywhere else (branches/PRs that
- * restore the base and publish a delta).
- */
-function shouldRestore() {
-  const input = (core.getInput("restore") || "auto").toLowerCase();
-  if (input === "false") return false;
-  if (input === "true") return true;
-  return !isDefaultBranchBuild();
-}
-
 module.exports = {
   install,
   backendArgs,
@@ -33725,7 +33711,6 @@ module.exports = {
   resolveBranch,
   defaultBranch,
   isDefaultBranchBuild,
-  shouldRestore,
 };
 
 

dist/pre/index.js

@@ -33687,7 +33687,8 @@ function defaultBranch() {
 /**
  * True when this run is a push build of the repository's default branch.
  * These builds publish a fresh full ("base") bundle and never restore, so the
- * bundle doesn't grow without bound across commits.
+ * bundle doesn't grow without bound across commits. Branches and PRs restore
+ * the base and publish a delta.
  */
 function isDefaultBranchBuild() {
   const event = process.env.GITHUB_EVENT_NAME || "";
@@ -33699,21 +33700,6 @@ function isDefaultBranchBuild() {
   return def !== "HEAD" && refName === def;
 }
 
-/**
- * Decide whether to restore a cache before the build.
- *
- * The `restore` input is an explicit override ("true"/"false"). When left at
- * the default ("auto"), restore is skipped on default-branch builds (which
- * publish a fresh base bundle) and enabled everywhere else (branches/PRs that
- * restore the base and publish a delta).
- */
-function shouldRestore() {
-  const input = (core.getInput("restore") || "auto").toLowerCase();
-  if (input === "false") return false;
-  if (input === "true") return true;
-  return !isDefaultBranchBuild();
-}
-
 module.exports = {
   install,
   backendArgs,
@@ -33725,7 +33711,6 @@ module.exports = {
   resolveBranch,
   defaultBranch,
   isDefaultBranchBuild,
-  shouldRestore,
 };