2.1.0

* Cache the zig compiler locally

* logging

* npm update

* verboser

* os.arch

* debug

* log signal

* address https://github.com/actions/toolkit/issues/687

* correct path

* add a cache: false option

* share size

* zigpath

* path.join skull

.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "04:00"
+  open-pull-requests-limit: 10

.github/workflows/build.yml

@@ -9,7 +9,7 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - run: npm install
       - uses: EndBug/add-and-commit@v4
         with:

.github/workflows/ci.yml

@@ -1,26 +1,35 @@
 name: CI
 on: push
 jobs:
-  lint:
+  test:
+    name: Unit tests
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: goto-bus-stop/standard-action@v1
-        with:
-          annotate: true
-        env:
-          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+      - name: Checkout sources
+        uses: actions/checkout@v3
+      - name: Install dependencies
+        run: npm install
+      - name: Run tests
+        run: npm test
 
   smoke-test:
+    name: Build test
     strategy:
+      fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        zig-version: [0.5.0, master]
+        zig-version: [0.7.0, 0.8.0, 0.9.0, 0.10.0]
+        include:
+          - os: ubuntu-latest
+            zig-version: 0.5.0
     runs-on: ${{matrix.os}}
     steps:
-      - uses: actions/checkout@v2
-      - uses: goto-bus-stop/setup-zig@default
+      - name: Checkout sources
+        uses: actions/checkout@v3
+      - name: Install Zig
+        uses: goto-bus-stop/setup-zig@default
         with:
           version: ${{matrix.zig-version}}
-      - run: zig build test
+      - name: Run tests
+        run: zig build test
         working-directory: test

CHANGELOG.md

@@ -4,6 +4,31 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 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)
+
+## 2.0.1
+* Update docs to v2
+
+## 2.0.0
+* Change `version` option default to `master`. See [#24](https://github.com/goto-bus-stop/setup-zig/issues/24)
+
+## 1.3.0
+* Support pinning to a specific commit of the zig compiler. ([@codehz](https://github.com/codehz) in [#14](https://github.com/goto-bus-stop/setup-zig/pull/14))
+  ```yaml
+  uses: goto-bus-stop/setup-zig@v1
+  with:
+    version: 0.6.0+4b48fccad
+  ```
+* Add tests for the version -> URL resolution code.
+
 ## 1.2.5
 * Update dependencies to fix #11.
 
@@ -14,7 +39,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 * Configure Actions to build releases automatically.
 
 ## 1.2.2
-* Update examples. (#7)
+* Update examples. ([#7](https://github.com/goto-bus-stop/setup-zig/pull/7))
 * Upgrade dependencies.
 * Recommend using @v1 instead of pinning to a version.
 

README.md

@@ -1,6 +1,6 @@
 # setup-zig
 
-Use the zig compiler in your Github Action
+Use the zig compiler in your Github Actions workflows
 
 [Usage](#usage) - [License: Apache-2.0](#license)
 
@@ -17,35 +17,49 @@ jobs:
     runs-on: ${{matrix.os}}
     steps:
       - uses: actions/checkout@v2
-      - uses: goto-bus-stop/setup-zig@v1
+      - uses: goto-bus-stop/setup-zig@v2
       - run: zig build test
   lint:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: goto-bus-stop/setup-zig@v1
+      - uses: goto-bus-stop/setup-zig@v2
       - run: zig fmt --check src/*.zig
 ```
 
 Optionally set a Zig version:
 ```yaml
-- uses: goto-bus-stop/setup-zig@v1
+- uses: goto-bus-stop/setup-zig@v2
   with:
-    version: 0.4.0 # The default is 0.5.0
+    version: 0.7.0
 ```
 
-To use the nightly builds, set:
+The default is to use the nightly `master` builds.
+
+Or [pin to a specific commit](https://github.com/goto-bus-stop/setup-zig/issues/13) using `version+commithash` syntax:
 ```yaml
-- uses: goto-bus-stop/setup-zig@v1
+- uses: goto-bus-stop/setup-zig@v2
   with:
-    version: master
+    version: 0.6.0+4b48fccad
 ```
 
-If you are running Zig on Windows machines, you need to make sure that your .zig files use \n line endings and not \r\n. The `actions/checkout` action auto-converts line endings to \r\n, so add a `.gitattributes` file:
+If you are running Zig on Windows machines, you need to make sure that your .zig files use \n line endings and not \r\n. The `actions/checkout` action auto-converts line endings to `\r\n` on Windows runners, so add a `.gitattributes` file:
 ```
 *.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

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

index.js

@@ -1,73 +1,77 @@
+'use strict'
+
 const os = require('os')
 const path = require('path')
 const semver = require('semver')
-const get = require('simple-get').concat
 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,
+  resolveVersion
+} = require('./versions')
 
-function getJSON (opts) {
-  return new Promise((resolve, reject) => {
-    get({ ...opts, json: true }, (err, req, data) => {
-      if (err) {
-        reject(err)
-      } else {
-        resolve(data)
-      }
-    })
-  })
-}
+const TOOL_NAME = 'zig'
 
-async function downloadZig (version) {
-  const host = {
-    linux: 'x86_64-linux',
-    darwin: 'x86_64-macos',
-    win32: 'x86_64-windows'
-  }[os.platform()] || os.platform()
-  const ext = {
-    linux: 'tar.xz',
-    darwin: 'tar.xz',
-    win32: 'zip'
-  }[os.platform()]
+async function downloadZig (platform, version, useCache = true) {
+  const ext = extForPlatform(platform)
 
-  const index = await getJSON({ url: 'https://ziglang.org/download/index.json' })
+  const { downloadUrl, variantName, version: useVersion } = version.includes('+')
+    ? resolveCommit(platform, version)
+    : await resolveVersion(platform, version)
 
-  const availableVersions = Object.keys(index)
-  const useVersion = semver.valid(version)
-    ? semver.maxSatisfying(availableVersions.filter((v) => semver.valid(v)), version)
-    : null
-
-  const meta = index[useVersion || version]
-  if (!meta || !meta[host]) {
-    throw new Error(`Could not find version ${version} for platform ${host}`)
+  const cachedPath = toolCache.find(TOOL_NAME, useVersion)
+  if (cachedPath) {
+    actions.info(`using cached zig install: ${cachedPath}`)
+    return cachedPath
   }
 
-  const variantName = path.basename(meta[host].tarball).replace(`.${ext}`, '')
+  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
+    }
+  }
 
-  const downloadPath = await cache.downloadTool(meta[host].tarball)
+  actions.info(`no cached version found. downloading zig ${variantName}`)
+  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, 'zig', variantName)
+  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') || '0.5.0'
+  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
   }
-
-  let zigPath = cache.find('zig', version)
-  if (!zigPath) {
-    zigPath = await downloadZig(version)
+  if (useCache !== 'false' && useCache !== 'true') {
+    actions.setFailed('`with.cache` must be "true" or "false"')
+    return
   }
 
+  const zigPath = await downloadZig(os.platform(), version, Boolean(useCache))
+
   // Add the `zig` binary to the $PATH
   actions.addPath(zigPath)
+  actions.info(`zig installed at ${zigPath}`)
 }
 
 main().catch((err) => {

package.json

@@ -1,20 +1,21 @@
 {
   "name": "setup-zig",
   "description": "Use the zig compiler in your Github Action",
-  "version": "1.2.5",
+  "version": "2.1.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": "^1.3.1",
+    "@actions/tool-cache": "^2.0.1",
     "semver": "^7.1.3",
     "simple-get": "^4.0.0"
   },
   "devDependencies": {
-    "@vercel/ncc": "^0.24.1",
-    "standard": "^14.3.1"
+    "esbuild": "^0.18.8",
+    "standard": "^17.0.0"
   },
   "homepage": "https://github.com/goto-bus-stop/setup-zig",
   "keywords": [
@@ -30,8 +31,8 @@
     "url": "https://github.com/goto-bus-stop/setup-zig.git"
   },
   "scripts": {
-    "prepare": "ncc build index.js -o dist",
-    "test": "standard"
+    "prepare": "esbuild index.js --outdir=dist --keep-names --bundle --platform=node --target=node16",
+    "test": "standard && node test"
   },
   "standard": {
     "ignore": [

test.js

@@ -0,0 +1,36 @@
+const assert = require('assert').strict
+const {
+  resolveCommit,
+  resolveVersion
+} = require('./versions')
+
+async function test () {
+  assert.deepEqual(resolveCommit('linux', '0.6.0+4b48fccad'), {
+    downloadUrl: 'https://ziglang.org/builds/zig-linux-x86_64-0.6.0+4b48fccad.tar.xz',
+    variantName: 'zig-linux-x86_64-0.6.0+4b48fccad',
+    version: '0.6.0+4b48fccad'
+  })
+  assert.deepEqual(resolveCommit('win32', '0.6.0+4b48fccad'), {
+    downloadUrl: 'https://ziglang.org/builds/zig-windows-x86_64-0.6.0+4b48fccad.zip',
+    variantName: 'zig-windows-x86_64-0.6.0+4b48fccad',
+    version: '0.6.0+4b48fccad'
+  })
+
+  assert.deepEqual(await resolveVersion('linux', '0.7.0'), {
+    downloadUrl: 'https://ziglang.org/download/0.7.0/zig-linux-x86_64-0.7.0.tar.xz',
+    variantName: 'zig-linux-x86_64-0.7.0',
+    version: '0.7.0'
+  })
+  assert.deepEqual(await resolveVersion('win32', '0.4.0'), {
+    downloadUrl: 'https://ziglang.org/download/0.4.0/zig-windows-x86_64-0.4.0.zip',
+    variantName: 'zig-windows-x86_64-0.4.0',
+    version: '0.4.0'
+  })
+  await assert.doesNotReject(resolveVersion('linux', 'master'))
+  await assert.doesNotReject(resolveVersion('win32', 'master'))
+}
+
+test().catch((error) => {
+  console.error(error.stack)
+  process.exit(1)
+})

versions.js

@@ -0,0 +1,69 @@
+const path = require('path')
+const get = require('simple-get').concat
+const semver = require('semver')
+
+function extForPlatform (platform) {
+  return {
+    linux: 'tar.xz',
+    darwin: 'tar.xz',
+    win32: 'zip'
+  }[platform]
+}
+
+function resolveCommit (platform, version) {
+  const ext = extForPlatform(platform)
+  const addrhost = {
+    linux: 'linux-x86_64',
+    darwin: 'macos-x86_64',
+    win32: 'windows-x86_64'
+  }[platform]
+
+  const downloadUrl = `https://ziglang.org/builds/zig-${addrhost}-${version}.${ext}`
+  const variantName = `zig-${addrhost}-${version}`
+
+  return { downloadUrl, variantName, version }
+}
+
+function getJSON (opts) {
+  return new Promise((resolve, reject) => {
+    get({ ...opts, json: true }, (err, req, data) => {
+      if (err) {
+        reject(err)
+      } else {
+        resolve(data)
+      }
+    })
+  })
+}
+
+async function resolveVersion (platform, version) {
+  const ext = extForPlatform(platform)
+  const host = {
+    linux: 'x86_64-linux',
+    darwin: 'x86_64-macos',
+    win32: 'x86_64-windows'
+  }[platform] || platform
+
+  const index = await getJSON({ url: 'https://ziglang.org/download/index.json' })
+
+  const availableVersions = Object.keys(index)
+  const useVersion = semver.valid(version)
+    ? semver.maxSatisfying(availableVersions.filter((v) => semver.valid(v)), version)
+    : null
+
+  const meta = index[useVersion || version]
+  if (!meta || !meta[host]) {
+    throw new Error(`Could not find version ${useVersion || version} for platform ${host}`)
+  }
+
+  const downloadUrl = meta[host].tarball
+  const variantName = path.basename(meta[host].tarball).replace(`.${ext}`, '')
+
+  return { downloadUrl, variantName, version: useVersion || version }
+}
+
+module.exports = {
+  extForPlatform,
+  resolveCommit,
+  resolveVersion
+}