Merge pull request #1118 from actions/pdotl/zstd-hotfix

Fix zstd not being used after zstd version upgrade to 1.5.4 on hosted runners
actions · Feb 21, 2023 · 69d9d44 · 69d9d44
2 parents 81b7281 + 8d3a1e0
commit 69d9d44
Show file tree

Hide file tree

Showing 9 changed files with 48 additions and 60 deletions.
diff --git a/.licenses/npm/@actions/cache.dep.yml b/.licenses/npm/@actions/cache.dep.yml
diff --git a/README.md b/README.md
@@ -31,6 +31,7 @@ See ["Caching dependencies to speed up workflows"](https://docs.github.com/en/ac
 * New actions are available for granular control over caches - [restore](restore/action.yml) and [save](save/action.yml).
 * Support cross-os caching as an opt-in feature. See [Cross OS caching](./tips-and-workarounds.md#cross-os-cache) for more info.
 * Added option to fail job on cache miss. See [Exit workflow on cache miss](./restore/README.md#exit-workflow-on-cache-miss) for more info.
+* Fix zstd not being used after zstd version upgrade to 1.5.4 on hosted runners
 
 See the [v2 README.md](https://github.com/actions/cache/blob/v2/README.md) for older updates.
 

diff --git a/RELEASES.md b/RELEASES.md
@@ -73,3 +73,6 @@
 
 ### 3.2.5
 - Added fix to prevent from setting MYSYS environment variable globally.
+
+### 3.2.6
+- Fix zstd not being used after zstd version upgrade to 1.5.4 on hosted runners.
diff --git a/dist/restore-only/index.js b/dist/restore-only/index.js
@@ -1152,12 +1152,13 @@ function unlinkFile(filePath) {
  });
 }
 exports.unlinkFile = unlinkFile;
-function getVersion(app) {
+function getVersion(app, additionalArgs = []) {
  return __awaiter(this, void 0, void 0, function* () {
- core.debug(`Checking ${app} --version`);
  let versionOutput = '';
+ additionalArgs.push('--version');
+ core.debug(`Checking ${app} ${additionalArgs.join(' ')}`);
  try {
- yield exec.exec(`${app} --version`, [], {
+ yield exec.exec(`${app}`, additionalArgs, {
  ignoreReturnCode: true,
  silent: true,
  listeners: {
@@ -1177,19 +1178,14 @@ function getVersion(app) {
 // Use zstandard if possible to maximize cache performance
 function getCompressionMethod() {
  return __awaiter(this, void 0, void 0, function* () {
- const versionOutput = yield getVersion('zstd');
+ const versionOutput = yield getVersion('zstd', ['--quiet']);
  const version = semver.clean(versionOutput);
- if (!versionOutput.toLowerCase().includes('zstd command line interface')) {
-  // zstd is not installed
+ core.debug(`zstd version: ${version}`);
+ if (versionOutput === '') {
  return constants_1.CompressionMethod.Gzip;
  }
- else if (!version || semver.lt(version, 'v1.3.2')) {
- // zstd is installed but using a version earlier than v1.3.2
- // v1.3.2 is required to use the `--long` options in zstd
- return constants_1.CompressionMethod.ZstdWithoutLong;
- }
  else {
- return constants_1.CompressionMethod.Zstd;
+ return constants_1.CompressionMethod.ZstdWithoutLong;
  }
  });
 }

diff --git a/dist/restore/index.js b/dist/restore/index.js
@@ -1152,12 +1152,13 @@ function unlinkFile(filePath) {
  });
 }
 exports.unlinkFile = unlinkFile;
-function getVersion(app) {
+function getVersion(app, additionalArgs = []) {
  return __awaiter(this, void 0, void 0, function* () {
- core.debug(`Checking ${app} --version`);
  let versionOutput = '';
+ additionalArgs.push('--version');
+ core.debug(`Checking ${app} ${additionalArgs.join(' ')}`);
  try {
- yield exec.exec(`${app} --version`, [], {
+ yield exec.exec(`${app}`, additionalArgs, {
  ignoreReturnCode: true,
  silent: true,
  listeners: {
@@ -1177,19 +1178,14 @@ function getVersion(app) {
 // Use zstandard if possible to maximize cache performance
 function getCompressionMethod() {
  return __awaiter(this, void 0, void 0, function* () {
- const versionOutput = yield getVersion('zstd');
+ const versionOutput = yield getVersion('zstd', ['--quiet']);
  const version = semver.clean(versionOutput);
- if (!versionOutput.toLowerCase().includes('zstd command line interface')) {
-  // zstd is not installed
+ core.debug(`zstd version: ${version}`);
+ if (versionOutput === '') {
  return constants_1.CompressionMethod.Gzip;
  }
- else if (!version || semver.lt(version, 'v1.3.2')) {
- // zstd is installed but using a version earlier than v1.3.2
- // v1.3.2 is required to use the `--long` options in zstd
- return constants_1.CompressionMethod.ZstdWithoutLong;
- }
  else {
- return constants_1.CompressionMethod.Zstd;
+ return constants_1.CompressionMethod.ZstdWithoutLong;
  }
  });
 }

diff --git a/dist/save-only/index.js b/dist/save-only/index.js
@@ -1208,12 +1208,13 @@ function unlinkFile(filePath) {
  });
 }
 exports.unlinkFile = unlinkFile;
-function getVersion(app) {
+function getVersion(app, additionalArgs = []) {
  return __awaiter(this, void 0, void 0, function* () {
- core.debug(`Checking ${app} --version`);
  let versionOutput = '';
+ additionalArgs.push('--version');
+ core.debug(`Checking ${app} ${additionalArgs.join(' ')}`);
  try {
- yield exec.exec(`${app} --version`, [], {
+ yield exec.exec(`${app}`, additionalArgs, {
  ignoreReturnCode: true,
  silent: true,
  listeners: {
@@ -1233,19 +1234,14 @@ function getVersion(app) {
 // Use zstandard if possible to maximize cache performance
 function getCompressionMethod() {
  return __awaiter(this, void 0, void 0, function* () {
- const versionOutput = yield getVersion('zstd');
+ const versionOutput = yield getVersion('zstd', ['--quiet']);
  const version = semver.clean(versionOutput);
- if (!versionOutput.toLowerCase().includes('zstd command line interface')) {
-  // zstd is not installed
+ core.debug(`zstd version: ${version}`);
+ if (versionOutput === '') {
  return constants_1.CompressionMethod.Gzip;
  }
- else if (!version || semver.lt(version, 'v1.3.2')) {
- // zstd is installed but using a version earlier than v1.3.2
- // v1.3.2 is required to use the `--long` options in zstd
- return constants_1.CompressionMethod.ZstdWithoutLong;
- }
  else {
- return constants_1.CompressionMethod.Zstd;
+ return constants_1.CompressionMethod.ZstdWithoutLong;
  }
  });
 }

diff --git a/dist/save/index.js b/dist/save/index.js
@@ -1152,12 +1152,13 @@ function unlinkFile(filePath) {
  });
 }
 exports.unlinkFile = unlinkFile;
-function getVersion(app) {
+function getVersion(app, additionalArgs = []) {
  return __awaiter(this, void 0, void 0, function* () {
- core.debug(`Checking ${app} --version`);
  let versionOutput = '';
+ additionalArgs.push('--version');
+ core.debug(`Checking ${app} ${additionalArgs.join(' ')}`);
  try {
- yield exec.exec(`${app} --version`, [], {
+ yield exec.exec(`${app}`, additionalArgs, {
  ignoreReturnCode: true,
  silent: true,
  listeners: {
@@ -1177,19 +1178,14 @@ function getVersion(app) {
 // Use zstandard if possible to maximize cache performance
 function getCompressionMethod() {
  return __awaiter(this, void 0, void 0, function* () {
- const versionOutput = yield getVersion('zstd');
+ const versionOutput = yield getVersion('zstd', ['--quiet']);
  const version = semver.clean(versionOutput);
- if (!versionOutput.toLowerCase().includes('zstd command line interface')) {
-  // zstd is not installed
+ core.debug(`zstd version: ${version}`);
+ if (versionOutput === '') {
  return constants_1.CompressionMethod.Gzip;
  }
- else if (!version || semver.lt(version, 'v1.3.2')) {
- // zstd is installed but using a version earlier than v1.3.2
- // v1.3.2 is required to use the `--long` options in zstd
- return constants_1.CompressionMethod.ZstdWithoutLong;
- }
  else {
- return constants_1.CompressionMethod.Zstd;
+ return constants_1.CompressionMethod.ZstdWithoutLong;
  }
  });
 }

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "cache",
- "version": "3.2.5",
+ "version": "3.2.6",
  "private": true,
  "description": "Cache dependencies and build outputs",
  "main": "dist/restore/index.js",
@@ -23,7 +23,7 @@
  "author": "GitHub",
  "license": "MIT",
  "dependencies": {
- "@actions/cache": "^3.1.3",
+ "@actions/cache": "^3.1.4",
  "@actions/core": "^1.10.0",
  "@actions/exec": "^1.1.1",
  "@actions/io": "^1.1.2"