chore(deps): update node.js to v24.14.0 (#147)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

.github/workflows/ci.yml

@@ -19,7 +19,7 @@ jobs:
           - ubuntu
           - windows
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - uses: ./
       - if: failure() && runner.debug == '1'
         uses: mxschmitt/action-tmate@v3

.github/workflows/release.yml

@@ -1,11 +1,12 @@
 name: Release
+run-name: Release ${{ inputs.tag }}
 on:
   workflow_dispatch:
     inputs:
       tag:
         description: Tag to release
         required: true
-        default: 0.0.0
+        default: 0.1.0
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -14,13 +15,23 @@ jobs:
   release:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
         with:
           cache: npm
           node-version-file: package.json
-      - run: npm build
       - run: |
-          git commit -am "Release ${{ inputs.tag }}"
-          git push
-          gh release create ${{ inputs.tag }} --generate-notes
+          sed -ri 's/"version": ".+"/"version": "${{ inputs.tag }}"/' package.json
+          sed -ri 's/setup-bazel@.+$/setup-bazel@${{ inputs.tag }}/g' README.md
+      - run: npm install
+      - run: npm run build
+      - run: |
+          git config user.name github-actions
+          git config user.email github-actions@github.com
+      - run: git commit -am "Release ${{ inputs.tag }}"
+      - run: git push
+      - run: git tag -a ${{ inputs.tag }} -m "Release ${{ inputs.tag }}"
+      - run: git push --tags
+      - run: gh release create ${{ inputs.tag }} --generate-notes
+        env:
+          GH_TOKEN: ${{ github.token }}

.tool-versions

@@ -1 +1 @@
-nodejs 20.12.2
+nodejs 24.14.0

README.md

@@ -6,7 +6,7 @@ and provides an advanced fine-grained caching to improve workflows performance.
 ## Usage
 
 ```yaml
-- uses: bazel-contrib/setup-bazel@0.8.1
+- uses: bazel-contrib/setup-bazel@0.18.0
   with:
     # Avoid downloading Bazel every time.
     bazelisk-cache: true
@@ -39,7 +39,7 @@ Default `""`.
   #### Install Bazelisk 1.x
 
   ```yaml
-  - uses: bazel-contrib/setup-bazel@0.8.1
+  - uses: bazel-contrib/setup-bazel@0.18.0
     with:
       bazelisk-version: 1.x
   ```
@@ -47,7 +47,7 @@ Default `""`.
   #### Install exact Bazelisk version
 
   ```yaml
-  - uses: bazel-contrib/setup-bazel@0.8.1
+  - uses: bazel-contrib/setup-bazel@0.18.0
     with:
       bazelisk-version: 1.19.0
   ```
@@ -67,7 +67,7 @@ Default `""`.
   #### Enable Bzlmod
 
   ```yaml
-  - uses: bazel-contrib/setup-bazel@0.8.1
+  - uses: bazel-contrib/setup-bazel@0.18.0
     with:
       bazelrc: common --enable_bzlmod
   ```
@@ -75,7 +75,7 @@ Default `""`.
   #### Add colors and timestamps
 
   ```yaml
-  - uses: bazel-contrib/setup-bazel@0.8.1
+  - uses: bazel-contrib/setup-bazel@0.18.0
     with:
       bazelrc: |
         build --color=yes
@@ -83,6 +83,30 @@ Default `""`.
   ```
 </details>
 
+### `cache-save`
+
+Whether to save caches at the end of the workflow.
+
+Set to `false` for pull requests to allow cache restoration without saving,
+which prevents PRs from polluting the cache while still benefiting from it.
+
+Default `true`.
+
+<details>
+  <summary>Examples</summary>
+
+  #### Disable cache saving on pull requests
+
+  ```yaml
+  - uses: bazel-contrib/setup-bazel@0.18.0
+    with:
+      bazelisk-cache: true
+      disk-cache: ${{ github.workflow }}
+      repository-cache: true
+      cache-save: ${{ github.event_name != 'pull_request' }}
+  ```
+</details>
+
 ### `disk-cache`
 
 Enable [`disk_cache`][2] and store it on GitHub based on contents of `BUILD` files.
@@ -97,7 +121,7 @@ Default `false`.
   #### Share a single disk cache
 
   ```yaml
-  - uses: bazel-contrib/setup-bazel@0.8.1
+  - uses: bazel-contrib/setup-bazel@0.18.0
     with:
       disk-cache: true
   ```
@@ -105,9 +129,9 @@ Default `false`.
   #### Separate disk caches between workflows
 
   ```yaml
-  - uses: bazel-contrib/setup-bazel@0.8.1
+  - uses: bazel-contrib/setup-bazel@0.18.0
     with:
-      disk-cache: ${{ github.workflow }}}
+      disk-cache: ${{ github.workflow }}
   ```
 </details>
 
@@ -129,7 +153,7 @@ Default `false`.
   #### Enable external repositories caches
 
   ```yaml
-  - uses: bazel-contrib/setup-bazel@0.8.1
+  - uses: bazel-contrib/setup-bazel@0.18.0
     with:
       external-cache: true
   ```
@@ -137,7 +161,7 @@ Default `false`.
   #### Cache NPM repositories based on `package-lock.json` contents
 
   ```yaml
-  - uses: bazel-contrib/setup-bazel@0.8.1
+  - uses: bazel-contrib/setup-bazel@0.18.0
     with:
       external-cache: |
         manifest:
@@ -147,7 +171,7 @@ Default `false`.
   #### Do not cache Ruby on Windows
 
   ```yaml
-  - uses: bazel-contrib/setup-bazel@0.8.1
+  - uses: bazel-contrib/setup-bazel@0.18.0
     with:
       external-cache: |
         manifest:
@@ -167,12 +191,42 @@ Default `""`.
   #### Authenticate via key
 
   ```yaml
-  - uses: bazel-contrib/setup-bazel@0.8.1
+  - uses: bazel-contrib/setup-bazel@0.18.0
     with:
       google-credentials: ${{ secrets.GOOGLE_CLOUD_KEY }}
   ```
 </details>
 
+### `module-root`
+
+Bazel module root directory, where `MODULE.bazel` and `WORKSPACE` is found.
+
+Change this value to the module root if it's not the repository root.
+
+Default `"."`.
+
+### `output-base`
+
+Change Bazel output base directory.
+
+You might want to change it when running on self-hosted runners with a custom directory layout.
+
+Default is one of the following:
+
+- `$HOME/.bazel` on Linux and macOS
+- `D:/_bazel` on Windows
+
+<details>
+  <summary>Examples</summary>
+
+  #### Use `C` drive letter
+
+  ```yaml
+  - uses: bazel-contrib/setup-bazel@0.18.0
+    with:
+      output-base: C:/_bazel
+  ```
+</details>
 
 ### `repository-cache`
 
@@ -188,7 +242,7 @@ Default `false`.
   #### Store a single repository cache
 
   ```yaml
-  - uses: bazel-contrib/setup-bazel@0.8.1
+  - uses: bazel-contrib/setup-bazel@0.18.0
     with:
       repository-cache: true
   ```
@@ -196,10 +250,19 @@ Default `false`.
   #### Store a repository cache from a custom location
 
   ```yaml
-  - uses: bazel-contrib/setup-bazel@0.8.1
+  - uses: bazel-contrib/setup-bazel@0.18.0
     with:
       repository-cache: examples/gem/WORKSPACE
   ```
+
+  #### Store a repository cache from a list of custom locations
+  ```yaml
+  - uses: bazel-contrib/setup-bazel@0.18.0
+    with:
+      repository-cache: |
+        - MODULE.bazel
+        - requirements_locked.txt
+  ```
 </details>
 
 ## Migrating from [`bazelbuild/setup-bazelisk`][6]
@@ -213,6 +276,7 @@ However, if you used a `bazel-version` input before, you will need to remove it
 To build action, run the following command:
 
 ```sh
+$ npm install
 $ npm run build
 ```
 

action.yml

@@ -13,6 +13,10 @@ inputs:
     description: Extra contents to write to user .bazelrc
     required: false
     default: ""
+  cache-save:
+    description: Whether to save caches. Set to false for pull requests to allow restores but prevent saves.
+    required: false
+    default: "true"
   cache-version:
     description: Version of all caches
     required: false
@@ -29,6 +33,14 @@ inputs:
     description: Google Cloud account key for remote cache
     required: false
     default: ""
+  module-root:
+    description: Bazel module root directory. Default is `.`
+    required: false
+    default: "."
+  output-base:
+    description: Bazel output base directory. Default is $HOME/.cache/bazel (POSIX) or D:/_bazel (Windows)
+    required: false
+    default: ""
   repository-cache:
     description: Cache repositories based on MODULE.bazel/WORKSPACE
     required: false
@@ -42,3 +54,4 @@ runs:
   using: node20
   main: dist/main/index.js
   post: dist/post/index.js
+  post-if: "!cancelled()"

config.js

@@ -5,16 +5,30 @@ const core = require('@actions/core')
 const github = require('@actions/github')
 
 const bazeliskVersion = core.getInput('bazelisk-version')
+const cacheSave = core.getBooleanInput('cache-save')
 const cacheVersion = core.getInput('cache-version')
-const externalCacheConfig = yaml.parse(core.getInput('external-cache'))
+const moduleRoot = core.getInput('module-root')
 
 const homeDir = os.homedir()
 const arch = os.arch()
 const platform = os.platform()
 
+let bazelOutputBase = core.getInput('output-base')
+if (!bazelOutputBase) {
+  if (platform === 'win32') {
+    // check if GITHUB_WORKSPACE starts with D:
+    if (process.env.GITHUB_WORKSPACE?.toLowerCase()?.startsWith('d:')) {
+      bazelOutputBase = 'D:/_bazel'
+    } else {
+      bazelOutputBase = `C:/_bazel`
+    }
+  } else {
+    bazelOutputBase = `${homeDir}/.bazel`
+  }
+}
+
 let bazelDisk = core.toPosixPath(`${homeDir}/.cache/bazel-disk`)
 let bazelRepository = core.toPosixPath(`${homeDir}/.cache/bazel-repo`)
-let bazelOutputBase = `${homeDir}/.bazel`
 let bazelrcPaths = [core.toPosixPath(`${homeDir}/.bazelrc`)]
 let userCacheDir = `${homeDir}/.cache`
 
@@ -23,9 +37,8 @@ switch (platform) {
     userCacheDir = `${homeDir}/Library/Caches`
     break
   case 'win32':
-    bazelDisk = 'D:/_bazel-disk'
-    bazelRepository = 'D:/_bazel-repo'
-    bazelOutputBase = 'D:/_bazel'
+    bazelDisk = `${bazelOutputBase}-disk`
+    bazelRepository = `${bazelOutputBase}-repo`
     userCacheDir = `${homeDir}/AppData/Local`
     if (process.env.HOME) {
       bazelrcPaths.push(core.toPosixPath(`${process.env.HOME}/.bazelrc`))
@@ -33,30 +46,33 @@ switch (platform) {
     break
 }
 
-const baseCacheKey = `setup-bazel-${cacheVersion}-${platform}`
+const baseCacheKey = `setup-bazel-${cacheVersion}-${platform}-${arch}`
 const bazelrc = core.getMultilineInput('bazelrc')
 
 const diskCacheConfig = core.getInput('disk-cache')
 const diskCacheEnabled = diskCacheConfig !== 'false'
 let diskCacheName = 'disk'
 if (diskCacheEnabled) {
+  // Before Bazel 6.3, providing --disk_cache to common is an error,
+  // with Bazel 6.3 and onwards, common accepts any legal Bazel option
+  // https://github.com/bazelbuild/bazel/issues/3054
   bazelrc.push(`build --disk_cache=${bazelDisk}`)
   if (diskCacheName !== 'true') {
     diskCacheName = `${diskCacheName}-${diskCacheConfig}`
   }
 }
 
-const repositoryCacheConfig = core.getInput('repository-cache')
-const repositoryCacheEnabled = repositoryCacheConfig !== 'false'
+const repositoryCacheConfig = yaml.parse(core.getInput('repository-cache'))
+const repositoryCacheEnabled = repositoryCacheConfig !== false
 let repositoryCacheFiles = [
-  'MODULE.bazel',
-  'WORKSPACE.bazel',
-  'WORKSPACE.bzlmod',
-  'WORKSPACE'
+  `${moduleRoot}/MODULE.bazel`,
+  `${moduleRoot}/WORKSPACE.bazel`,
+  `${moduleRoot}/WORKSPACE.bzlmod`,
+  `${moduleRoot}/WORKSPACE`
 ]
 if (repositoryCacheEnabled) {
-  bazelrc.push(`build --repository_cache=${bazelRepository}`)
-  if (repositoryCacheConfig !== 'true') {
+  bazelrc.push(`common --repository_cache=${bazelRepository}`)
+  if (repositoryCacheConfig !== true) {
     repositoryCacheFiles = Array(repositoryCacheConfig).flat()
   }
 }
@@ -64,13 +80,14 @@ if (repositoryCacheEnabled) {
 const googleCredentials = core.getInput('google-credentials')
 const googleCredentialsSaved = (core.getState('google-credentials-path').length > 0)
 if (googleCredentials.length > 0 && !googleCredentialsSaved) {
-  const tmpDir = core.toPosixPath(fs.mkdtempSync(os.tmpdir()))
+  const tmpDir = core.toPosixPath(fs.mkdtempSync(process.env.RUNNER_TEMP))
   const googleCredentialsPath = `${tmpDir}/key.json`
   fs.writeFileSync(googleCredentialsPath, googleCredentials)
   bazelrc.push(`build --google_credentials=${googleCredentialsPath}`)
   core.saveState('google-credentials-path', googleCredentialsPath)
 }
 
+const externalCacheConfig = yaml.parse(core.getInput('external-cache'))
 const bazelExternal = core.toPosixPath(`${bazelOutputBase}/external`)
 const externalCache = {}
 if (externalCacheConfig) {
@@ -83,10 +100,10 @@ if (externalCacheConfig) {
   externalCache.baseCacheKey = `${baseCacheKey}-external-`
   externalCache.manifest = {
     files: [
-      'MODULE.bazel',
-      'WORKSPACE.bazel',
-      'WORKSPACE.bzlmod',
-      'WORKSPACE'
+      `${moduleRoot}/MODULE.bazel`,
+      `${moduleRoot}/WORKSPACE.bazel`,
+      `${moduleRoot}/WORKSPACE.bzlmod`,
+      `${moduleRoot}/WORKSPACE`
     ],
     name: `external-${manifestName}-manifest`,
     path: `${os.tmpdir()}/external-cache-manifest.txt`
@@ -94,10 +111,10 @@ if (externalCacheConfig) {
   externalCache.default = {
     enabled: true,
     files: [
-      'MODULE.bazel',
-      'WORKSPACE.bazel',
-      'WORKSPACE.bzlmod',
-      'WORKSPACE'
+      `${moduleRoot}/MODULE.bazel`,
+      `${moduleRoot}/WORKSPACE.bazel`,
+      `${moduleRoot}/WORKSPACE.bzlmod`,
+      `${moduleRoot}/WORKSPACE`
     ],
     name: (name) => { return `external-${name}` },
     paths: (name) => {
@@ -116,11 +133,15 @@ if (externalCacheConfig) {
   }
 }
 
+const token = core.getInput('token')
+core.exportVariable('BAZELISK_GITHUB_TOKEN', token)
+
 module.exports = {
   baseCacheKey,
+  cacheSave,
   bazeliskCache: {
     enabled: core.getBooleanInput('bazelisk-cache'),
-    files: ['.bazelversion'],
+    files: [`${moduleRoot}/.bazelversion`],
     name: 'bazelisk',
     paths: [core.toPosixPath(`${userCacheDir}/bazelisk`)]
   },
@@ -129,8 +150,9 @@ module.exports = {
   diskCache: {
     enabled: diskCacheEnabled,
     files: [
-      '**/BUILD.bazel',
-      '**/BUILD'
+      ...repositoryCacheFiles,
+      `${moduleRoot}/**/BUILD.bazel`,
+      `${moduleRoot}/**/BUILD`
     ],
     name: diskCacheName,
     paths: [bazelDisk]

index.js

@@ -17,8 +17,8 @@ async function run() {
 
 async function setupBazel() {
   core.startGroup('Configure Bazel')
-  console.log('Configuration:')
-  console.log(JSON.stringify(config, null, 2))
+  core.info('Configuration:')
+  core.info(JSON.stringify(config, null, 2))
 
   await setupBazelrc()
   core.endGroup()
@@ -36,18 +36,19 @@ async function setupBazelisk() {
   }
 
   core.startGroup('Setup Bazelisk')
-  const toolPath = tc.find('bazelisk', config.bazeliskVersion)
+  let toolPath = tc.find('bazelisk', config.bazeliskVersion)
   if (toolPath) {
-    console.log(`Found in cache @ ${toolPath}`)
+    core.debug(`Found in cache @ ${toolPath}`)
   } else {
-    await downloadBazelisk()
+    toolPath = await downloadBazelisk()
   }
+  core.addPath(toolPath)
   core.endGroup()
 }
 
 async function downloadBazelisk() {
   const version = config.bazeliskVersion
-  console.log(`Attempting to download ${version}`)
+  core.debug(`Attempting to download ${version}`)
 
   // Possible values are 'arm', 'arm64', 'ia32', 'mips', 'mipsel', 'ppc', 'ppc64', 's390', 's390x' and 'x64'.
   // Bazelisk filenames use 'amd64' and 'arm64'.
@@ -68,8 +69,10 @@ async function downloadBazelisk() {
     filename = `${filename}.exe`
   }
 
-  const token = core.getInput('token')
-  const octokit = github.getOctokit(token)
+  const token = process.env.BAZELISK_GITHUB_TOKEN
+  const octokit = github.getOctokit(token, {
+    baseUrl: 'https://api.github.com'
+  })
   const { data: releases } = await octokit.rest.repos.listReleases({
     owner: 'bazelbuild',
     repo: 'bazelisk'
@@ -88,15 +91,19 @@ async function downloadBazelisk() {
   }
 
   const url = asset.browser_download_url
-  console.log(`Downloading from ${url}`)
+  core.debug(`Downloading from ${url}`)
   const downloadPath = await tc.downloadTool(url, undefined, `token ${token}`)
 
-  console.log('Adding to the cache...');
+  core.debug('Adding to the cache...');
   fs.chmodSync(downloadPath, '755');
-  const cachePath = await tc.cacheFile(downloadPath, 'bazel', 'bazelisk', version)
-  console.log(`Successfully cached bazelisk to ${cachePath}`)
+  let bazel_name = "bazel";
+  if (platform == 'windows') {
+    bazel_name = `${bazel_name}.exe`
+  }
+  const cachePath = await tc.cacheFile(downloadPath, bazel_name, 'bazelisk', version)
+  core.debug(`Successfully cached bazelisk to ${cachePath}`)
 
-  core.addPath(cachePath)
+  return cachePath
 }
 
 async function setupBazelrc() {
@@ -126,14 +133,16 @@ async function restoreExternalCaches(cacheConfig) {
   // Now restore all external caches defined in manifest
   if (fs.existsSync(path)) {
     const manifest = fs.readFileSync(path, { encoding: 'utf8' })
-    for (const name of manifest.split('\n').filter(s => s)) {
-      await restoreCache({
-        enabled: cacheConfig[name]?.enabled ?? cacheConfig.default.enabled,
-        files: cacheConfig[name]?.files || cacheConfig.default.files,
-        name: cacheConfig.default.name(name),
-        paths: cacheConfig.default.paths(name)
-      })
-    }
+    const restorePromises = manifest.split('\n').filter(s => s)
+      .map(name => {
+        return restoreCache({
+          enabled: cacheConfig[name]?.enabled ?? cacheConfig.default.enabled,
+          files: cacheConfig[name]?.files || cacheConfig.default.files,
+          name: cacheConfig.default.name(name),
+          paths: cacheConfig.default.paths(name)
+        });
+      });
+    await Promise.all(restorePromises);
   }
 }
 
@@ -143,16 +152,17 @@ async function restoreCache(cacheConfig) {
   }
 
   const delay = Math.random() * 1000 // timeout <= 1 sec to reduce 429 errors
-  await setTimeout(delay, async function () {
-    core.startGroup(`Restore cache for ${cacheConfig.name}`)
+  await setTimeout(delay)
 
+  core.startGroup(`Restore cache for ${cacheConfig.name}`)
+  try {
     const hash = await glob.hashFiles(cacheConfig.files.join('\n'))
     const name = cacheConfig.name
     const paths = cacheConfig.paths
     const restoreKey = `${config.baseCacheKey}-${name}-`
     const key = `${restoreKey}${hash}`
 
-    console.log(`Attempting to restore ${name} cache from ${key}`)
+    core.debug(`Attempting to restore ${name} cache from ${key}`)
 
     const restoredKey = await cache.restoreCache(
       paths, key, [restoreKey],
@@ -160,17 +170,19 @@ async function restoreCache(cacheConfig) {
     )
 
     if (restoredKey) {
-      console.log(`Successfully restored cache from ${restoredKey}`)
+      core.info(`Successfully restored cache from ${restoredKey}`)
 
       if (restoredKey === key) {
         core.saveState(`${name}-cache-hit`, 'true')
       }
     } else {
-      console.log(`Failed to restore ${name} cache`)
+      core.info(`Failed to restore ${name} cache`)
     }
-
+  } catch (err) {
+    core.warning(`Failed to restore ${name} cache with error: ${err}`)
+  } finally {
     core.endGroup()
-  }())
+  }
 }
 
 run()

package.json

@@ -1,10 +1,10 @@
 {
   "name": "setup-bazel",
-  "version": "0.8.1",
+  "version": "0.18.0",
   "description": "Install and configure Bazel for GitHub Actions",
   "main": "index.js",
   "engines": {
-    "node": "20.x"
+    "node": "24.x"
   },
   "scripts": {
     "build": "ncc build index.js -s -o dist/main && ncc build post.js -s -o dist/post",
@@ -13,11 +13,11 @@
   "author": "Alex Rodionov <p0deje@gmail.com>",
   "license": "MIT",
   "dependencies": {
-    "@actions/cache": "^3.2.2",
-    "@actions/core": "^1.10.1",
-    "@actions/github": "^6.0.0",
-    "@actions/glob": "^0.4.0",
-    "@actions/tool-cache": "^2.0.1",
+    "@actions/cache": "^6.0.0",
+    "@actions/core": "^3.0.0",
+    "@actions/github": "^9.0.0",
+    "@actions/glob": "^0.6.0",
+    "@actions/tool-cache": "^4.0.0",
     "@vercel/ncc": "^0.38.0",
     "yaml": "^2.2.1"
   }

post.js

@@ -5,12 +5,19 @@ const core = require('@actions/core')
 const glob = require('@actions/glob')
 const config = require('./config')
 const { getFolderSize } = require('./util')
+const process = require('node:process');
 
 async function run() {
   await saveCaches()
+  process.exit(0)
 }
 
 async function saveCaches() {
+  if (!config.cacheSave) {
+    core.info('Cache saving is disabled (cache-save: false)')
+    return
+  }
+
   await saveCache(config.bazeliskCache)
   await saveCache(config.diskCache)
   await saveCache(config.repositoryCache)
@@ -79,9 +86,9 @@ async function saveCache(cacheConfig) {
       { followSymbolicLinks: false }
     )
     const key = `${config.baseCacheKey}-${cacheConfig.name}-${hash}`
-    console.log(`Attempting to save ${paths} cache to ${key}`)
+    core.debug(`Attempting to save ${paths} cache to ${key}`)
     await cache.saveCache(paths, key)
-    console.log('Successfully saved cache')
+    core.info('Successfully saved cache')
   } catch (error) {
     core.warning(error.stack)
   } finally {