new: Add caching inputs/settings. (#8)

Author: milesj

CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.2.0
+
+- Added a `cache` input to toggle caching of the toolchain. Defaults to true.
+- Added a `cache-base` input. When provided, will only save cache on this branch/ref, but will
+  restore cache on all branches/refs.
+
 # 0.1.2
 
 - Improve cache key checks.

README.md

@@ -30,6 +30,9 @@ jobs:
 ## Inputs
 
 - `auto-install` - Auto-install tools on setup. Defaults to `false`.
+- `cache` - Toggle caching of the toolchain directory. Defaults to `true`.
+- `cache-base` - Base branch/ref to save a warmup cache on. Other branches/refs will restore from
+  this base.
 - `moon-version` - Version of moon to explicitly install (if repository is using moon). Defaults to
   "latest".
 - `proto-version` - Version of proto to explicitly install. Defaults to "latest".

action.yml

@@ -5,6 +5,12 @@ inputs:
   auto-install:
     default: false
     description: 'Auto-install tools on setup.'
+  cache:
+    description: 'Toggle caching of the toolchain directory.'
+    default: true
+  cache-base:
+    description:
+      'Base branch/ref to save a warmup cache on. Other branches/refs will restore from this base.'
   moon-version:
     default: 'latest'
     description: 'Version of moon to install (if repository is using moon).'

helpers.ts

@@ -2,6 +2,7 @@ import fs from 'node:fs';
 import os from 'node:os';
 import path from 'node:path';
 import execa from 'execa';
+import * as cache from '@actions/cache';
 import * as core from '@actions/core';
 import * as glob from '@actions/glob';
 import * as tc from '@actions/tool-cache';
@@ -40,6 +41,10 @@ export function getWorkingDir() {
 	return process.env.GITHUB_WORKSPACE ?? process.cwd();
 }
 
+export function isCacheEnabled(): boolean {
+	return core.getBooleanInput('cache') && cache.isFeatureAvailable();
+}
+
 export function isUsingMoon() {
 	return fs.existsSync(path.join(getWorkingDir(), core.getInput('workspace-root'), '.moon'));
 }

index.ts

@@ -9,11 +9,12 @@ import {
 	getToolchainCacheKey,
 	getToolsDir,
 	installBin,
+	isCacheEnabled,
 	isUsingMoon,
 } from './helpers';
 
 async function restoreCache() {
-	if (!cache.isFeatureAvailable()) {
+	if (!isCacheEnabled()) {
 		return;
 	}
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moonrepo/setup-toolchain",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "A GitHub action to setup and cache the proto and moon toolchains.",
   "main": "dist/index.js",
   "scripts": {

post.ts

@@ -2,7 +2,7 @@ import fs from 'node:fs';
 import execa from 'execa';
 import * as cache from '@actions/cache';
 import * as core from '@actions/core';
-import { getPluginsDir, getToolchainCacheKey, getToolsDir } from './helpers';
+import { getPluginsDir, getToolchainCacheKey, getToolsDir, isCacheEnabled } from './helpers';
 
 async function cleanToolchain() {
 	try {
@@ -14,8 +14,17 @@ async function cleanToolchain() {
 	}
 }
 
+function shouldSaveCache() {
+	const base = core.getInput('cache-base');
+
+	// Only save the cache for the following 2 scenarios:
+	//	- If not using the base warmup strategy.
+	//	- If using the base warmup strategy, and the current ref matches.
+	return !base || !!(base && !!(process.env.GITHUB_REF_NAME ?? '').match(base));
+}
+
 async function saveCache() {
-	if (!cache.isFeatureAvailable()) {
+	if (!isCacheEnabled() || !shouldSaveCache()) {
 		return;
 	}