test

Bumps [esbuild](https://github.com/evanw/esbuild) from 0.19.12 to 0.20.0.
- [Release notes](https://github.com/evanw/esbuild/releases)
- [Changelog](https://github.com/evanw/esbuild/blob/main/CHANGELOG.md)
- [Commits](https://github.com/evanw/esbuild/compare/v0.19.12...v0.20.0)

---
updated-dependencies:
- dependency-name: esbuild
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.editorconfig

@@ -0,0 +1,23 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+
+[*.js]
+indent_style = space
+indent_size = 2
+
+
+[*.md]
+trim_trailing_whitespace = false

.github/dependabot.yml

@@ -6,3 +6,9 @@ updates:
     interval: daily
     time: "04:00"
   open-pull-requests-limit: 10
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "04:00"
+  open-pull-requests-limit: 10

.github/workflows/build.yml

@@ -9,13 +9,9 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - run: npm install
-      - uses: EndBug/add-and-commit@v4
+      - uses: EndBug/add-and-commit@v9
         with:
           add: dist
-          message: Rebuild
-          author_name: Automated
-          author_email: github@asdf.kooi.me
-        env:
-          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          message: Rebuild (automated)

.github/workflows/ci.yml

@@ -6,7 +6,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install dependencies
         run: npm install
       - name: Run tests
@@ -18,18 +18,23 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        zig-version: [0.7.0, 0.8.0, 0.9.0, 0.10.0]
+        zig-version: [0.7.0, 0.8.0, 0.9.0, 0.10.0, 0.11.0]
         include:
           - os: ubuntu-latest
             zig-version: 0.5.0
     runs-on: ${{matrix.os}}
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install Zig
         uses: goto-bus-stop/setup-zig@default
         with:
           version: ${{matrix.zig-version}}
-      - name: Run tests
+      - name: Run tests (zig up to v0.10.x)
+        if: ${{ !startsWith(matrix.zig-version, '0.11.') }}
         run: zig build test
-        working-directory: test
+        working-directory: test/v0.10
+      - name: Run tests (zig v0.11.x)
+        if: ${{ startsWith(matrix.zig-version, '0.11.') }}
+        run: zig build test
+        working-directory: test/v0.11

.gitignore

@@ -1,3 +1,5 @@
+node_modules
+
 # Logs
 logs
 *.log

CHANGELOG.md

@@ -4,6 +4,24 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 2.2.0
+* Update the action to use Node.js 20. [#61](https://github.com/goto-bus-stop/setup-zig/pull/61)
+* Add a test for zig 0.11.0. [#62](https://github.com/goto-bus-stop/setup-zig/pull/62)
+
+Thanks [@chenrui333](https://github.com/chenrui333)!
+
+## 2.1.1
+* Fix `cache: false`, see [#55](https://github.com/goto-bus-stop/setup-zig/issues/55).
+
+Thanks to [@linusg](https://github.com/linusg) for the report!
+
+## 2.1.0
+* The action now caches compilers in your repository's Actions cache by default. This significantly
+  speeds up installs on average. [#53](https://github.com/goto-bus-stop/setup-zig/pull/53)
+
+  2.0.2 also had caching-related changes but they didn't actually do much, based on a misunderstanding
+  of what the `tool-cache` is for.
+
 ## 2.0.2
 * Fix tool-cache usage, this should speed up the action if zig was already downloaded before. [#45](https://github.com/goto-bus-stop/setup-zig/pull/45)
 

README.md

@@ -24,7 +24,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - uses: goto-bus-stop/setup-zig@v2
-      - run: zig fmt --check src/*.zig
+      - run: zig fmt --check .
 ```
 
 Optionally set a Zig version:
@@ -48,6 +48,18 @@ If you are running Zig on Windows machines, you need to make sure that your .zig
 *.zig text eol=lf
 ```
 
+This action caches the downloaded compilers in your repository's Actions cache by default,
+to reduce the load on the Zig Foundation's servers. Cached compilers are only about 60MB
+each per version/OS/architecture.
+
+If this is really bad for you for some reason you can disable the caching.
+
+```yaml
+- uses: goto-bus-stop/setup-zig@v2
+  with:
+    cache: false
+```
+
 ## License
 
 [Apache-2.0](LICENSE.md)

action.yml

@@ -9,6 +9,10 @@ inputs:
     description: 'Version of the zig compiler to use (must be 0.3.0 or up)'
     required: true
     default: 'master'
+  cache:
+    description: 'Cache downloaded compilers for faster action runs. Strongly recommended.'
+    required: false
+    default: 'true'
 runs:
-  using: 'node16'
+  using: 'node20'
   main: 'dist/index.js'

index.js

@@ -4,7 +4,8 @@ const os = require('os')
 const path = require('path')
 const semver = require('semver')
 const actions = require('@actions/core')
-const cache = require('@actions/tool-cache')
+const cache = require('@actions/cache')
+const toolCache = require('@actions/tool-cache')
 const {
   extForPlatform,
   resolveCommit,
@@ -13,40 +14,60 @@ const {
 
 const TOOL_NAME = 'zig'
 
-async function downloadZig (platform, version) {
+async function downloadZig (platform, version, useCache = true) {
   const ext = extForPlatform(platform)
 
   const { downloadUrl, variantName, version: useVersion } = version.includes('+')
     ? resolveCommit(platform, version)
     : await resolveVersion(platform, version)
 
-  const cachedPath = cache.find(TOOL_NAME, useVersion)
+  const cachedPath = toolCache.find(TOOL_NAME, useVersion)
   if (cachedPath) {
     actions.info(`using cached zig install: ${cachedPath}`)
     return cachedPath
   }
 
+  const cacheKey = `${TOOL_NAME}-${variantName}`
+  if (useCache) {
+    const restorePath = path.join(process.env.RUNNER_TOOL_CACHE, TOOL_NAME, useVersion, os.arch())
+    actions.info(`attempting restore of ${cacheKey} to ${restorePath}`)
+    const restoredKey = await cache.restoreCache([restorePath], cacheKey)
+    if (restoredKey) {
+      actions.info(`using cached zig install: ${restorePath}`)
+      return restorePath
+    }
+  }
+
   actions.info(`no cached version found. downloading zig ${variantName}`)
-  const downloadPath = await cache.downloadTool(downloadUrl)
+  const downloadPath = await toolCache.downloadTool(downloadUrl)
   const zigPath = ext === 'zip'
-    ? await cache.extractZip(downloadPath)
-    : await cache.extractTar(downloadPath, undefined, 'x')
+    ? await toolCache.extractZip(downloadPath)
+    : await toolCache.extractTar(downloadPath, undefined, 'x')
 
   const binPath = path.join(zigPath, variantName)
-  const cachePath = await cache.cacheDir(binPath, TOOL_NAME, useVersion)
-  actions.info(`added zig ${useVersion} to the tool cache`)
+  const cachePath = await toolCache.cacheDir(binPath, TOOL_NAME, useVersion)
+
+  if (useCache) {
+    actions.info(`adding zig ${useVersion} at ${cachePath} to local cache ${cacheKey}`)
+    await cache.saveCache([cachePath], cacheKey)
+  }
 
   return cachePath
 }
 
 async function main () {
   const version = actions.getInput('version') || 'master'
+  const useCache = actions.getInput('cache') || 'true'
   if (semver.valid(version) && semver.lt(version, '0.3.0')) {
     actions.setFailed('This action does not work with Zig 0.1.0 and Zig 0.2.0')
     return
   }
+  if (useCache !== 'false' && useCache !== 'true') {
+    actions.setFailed('`with.cache` must be "true" or "false"')
+    return
+  }
 
-  const zigPath = await downloadZig(os.platform(), version)
+  const zigPath = await downloadZig(os.platform(), version, useCache === 'true')
 
   // Add the `zig` binary to the $PATH
   actions.addPath(zigPath)

package.json

@@ -1,19 +1,20 @@
 {
   "name": "setup-zig",
   "description": "Use the zig compiler in your Github Action",
-  "version": "2.0.2",
+  "version": "2.2.0",
   "author": "Renée Kooi <renee@kooi.me>",
   "bugs": {
     "url": "https://github.com/goto-bus-stop/setup-zig/issues"
   },
   "dependencies": {
+    "@actions/cache": "^3.2.1",
     "@actions/core": "^1.2.2",
     "@actions/tool-cache": "^2.0.1",
     "semver": "^7.1.3",
     "simple-get": "^4.0.0"
   },
   "devDependencies": {
-    "esbuild": "^0.17.19",
+    "esbuild": "^0.20.0",
     "standard": "^17.0.0"
   },
   "homepage": "https://github.com/goto-bus-stop/setup-zig",
@@ -30,7 +31,7 @@
     "url": "https://github.com/goto-bus-stop/setup-zig.git"
   },
   "scripts": {
-    "prepare": "esbuild index.js --outdir=dist --bundle --platform=node",
+    "prepare": "esbuild index.js --outdir=dist --keep-names --bundle --platform=node --target=node20",
     "test": "standard && node test"
   },
   "standard": {

test/v0.11/build.zig

@@ -0,0 +1,13 @@
+const Build = @import("std").Build;
+
+pub fn build(b: *Build) void {
+    const optimize = b.standardOptimizeOption(.{});
+    const test_build = b.addTest(.{
+        .root_source_file = .{ .path = "src/main.zig" },
+        .optimize = optimize,
+    });
+    const run_test = b.addRunArtifact(test_build);
+
+    const test_step = b.step("test", "Run the app");
+    test_step.dependOn(&run_test.step);
+}

test/v0.11/src/main.zig

@@ -0,0 +1,5 @@
+const debug = @import("std").debug;
+
+test "it works" {
+    debug.assert(1 == 1);
+}