feat: support downloading the latest version automatically (#70)

Author: y-yagi

README.md

@@ -44,7 +44,7 @@ Since Supabase CLI relies on Docker Engine API, additional setup may be required
 
 The actions supports the following inputs:
 
-- `version`: The version of `supabase` to install, defaulting to `1.0.0`
+- `version`: The version of `supabase` to install, defaulting to `1.0.0`. You can also specify `latest` to use the latest version.
 
 ## Advanced Usage
 

__tests__/main.test.ts

@@ -6,12 +6,19 @@ import * as path from 'path'
 import {expect, test} from '@jest/globals'
 
 test('gets download url to binary', async () => {
-  const url = getDownloadUrl('0.1.0')
+  const url = await getDownloadUrl('0.1.0')
   expect(url).toContain(
     'https://github.com/supabase/cli/releases/download/v0.1.0/'
   )
 })
 
+test('gets download url to binary with "latest" version', async () => {
+  const url = await getDownloadUrl('latest')
+  expect(url).toMatch(
+    /^https:\/\/github.com\/supabase\/cli\/releases\/download\/v[0-9]+\.[0-9]+\.[0-9]+\/supabase_[0-9]+\.[0-9]+\.[0-9]+/
+  )
+})
+
 // shows how the runner will run a javascript action with env / stdout protocol
 test('test runs', () => {
   process.env['RUNNER_TEMP'] = os.tmpdir()

dist/index.js

@@ -26,6 +26,7 @@
   "license": "MIT",
   "dependencies": {
     "@actions/core": "^1.10.0",
+    "@actions/http-client": "^2.0.1",
     "@actions/tool-cache": "^2.0.1"
   },
   "devDependencies": {

dist/index.js.map

@@ -8,7 +8,7 @@ async function run(): Promise<void> {
     const version = core.getInput('version')
 
     // Download the specific version of the tool, e.g. as a tarball/zipball
-    const download = getDownloadUrl(version)
+    const download = await getDownloadUrl(version)
     const pathToTarball = await tc.downloadTool(download)
 
     // Extract the tarball/zipball onto host runner

package-lock.json

@@ -1,4 +1,9 @@
 import os from 'os'
+import * as httpm from '@actions/http-client'
+
+interface GitHubTag {
+  tag_name: string
+}
 
 // arch in [arm, arm64, x64...] (https://nodejs.org/docs/latest-v16.x/api/os.html#osarch)
 // return value in [amd64, arm64, arm]
@@ -18,9 +23,26 @@ const mapOS = (platform: string): string => {
   return mappings[platform] || platform
 }
 
-export const getDownloadUrl = (version: string): string => {
+export const getDownloadUrl = async (version: string): Promise<string> => {
   const platform = mapOS(os.platform())
   const arch = mapArch(os.arch())
-  const filename = `supabase_${version}_${platform}_${arch}`
-  return `https://github.com/supabase/cli/releases/download/v${version}/${filename}.tar.gz`
+  const resolvedVersion = await resolveVersion(version)
+  const filename = `supabase_${resolvedVersion}_${platform}_${arch}`
+
+  return `https://github.com/supabase/cli/releases/download/v${resolvedVersion}/${filename}.tar.gz`
+}
+
+const resolveVersion = async (version: string): Promise<string> => {
+  if (version !== 'latest') {
+    return version
+  }
+
+  const http: httpm.HttpClient = new httpm.HttpClient('setup-cli')
+  const url = 'https://api.github.com/repos/supabase/cli/releases/latest'
+  const tag = (await http.getJson<GitHubTag>(url)).result?.tag_name
+  if (!tag) {
+    throw new Error('Cannot fetch tag info')
+  }
+
+  return tag.substring(1)
 }