Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion dist/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ export declare function isAuthenticated(): Promise<boolean>;
* specification is installed.
* @returns The path of the installed tool.
*/
export declare function installGcloudSDK(version: string, skipToolCache?: boolean): Promise<string>;
export declare function installGcloudSDK(version: string, useToolCache?: boolean): Promise<string>;
/**
* computeGcloudVersion computes the appropriate gcloud version for the given
* string. If the string is the empty string or the special value "latest", it
Expand Down
31 changes: 16 additions & 15 deletions dist/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -41738,7 +41738,7 @@ async function isAuthenticated() {
* specification is installed.
* @returns The path of the installed tool.
*/
async function installGcloudSDK(version, skipToolCache) {
async function installGcloudSDK(version, useToolCache = false) {
// Retrieve the release corresponding to the specified version and OS
const osPlat = os.platform();
const osArch = os.arch();
Expand All @@ -41752,24 +41752,25 @@ async function installGcloudSDK(version, skipToolCache) {
throw new Error(`Failed to download release, url: ${url}`);
}
// Either cache the tool or just add it directly to the path.
if (skipToolCache) {
// Caching the tool on disk takes a really long time, and it's not clear
// whether it's even valuable since it's ONLY cached on disk on the runner.
// For GitHub-managed runners, that is useless since they are ephemeral.
//
// See https://github.com/google-github-actions/setup-gcloud/issues/701 for
// discussion, but it's actually faster to skip the caching and just add the
// tool directly to the path.
const toolRoot = path.join(extPath, 'google-cloud-sdk');
core.addPath(path.join(toolRoot, 'bin'));
return toolRoot;
}
else {
//
// Caching the tool on disk takes a really long time, and it's not clear
// whether it's even valuable since it's ONLY cached on disk on the runner.
// For GitHub-managed runners, that is useless since they are ephemeral.
//
// See https://github.com/google-github-actions/setup-gcloud/issues/701 for
// discussion, but it's actually faster to skip the caching and just add the
// tool directly to the path.
if (useToolCache) {
const toolRoot = path.join(extPath, 'google-cloud-sdk');
const cachedToolRoot = await toolCache.cacheDir(toolRoot, 'gcloud', resolvedVersion, osArch);
core.addPath(path.join(cachedToolRoot, 'bin'));
return cachedToolRoot;
}
else {
const toolRoot = path.join(extPath, 'google-cloud-sdk');
core.addPath(path.join(toolRoot, 'bin'));
return toolRoot;
}
}
/**
* computeGcloudVersion computes the appropriate gcloud version for the given
Expand Down Expand Up @@ -43928,7 +43929,7 @@ module.exports = parseParams
/***/ ((module) => {

"use strict";
module.exports = /*#__PURE__*/JSON.parse('{"name":"@google-github-actions/setup-cloud-sdk","version":"1.2.2","description":"Utilities to download, install, and interact with the Cloud SDK for GitHub Actions","module":"dist/index.js","main":"dist/index.js","types":"dist/index.d.js","engines":{"node":">= 20.x","npm":">= 10.x"},"scripts":{"build":"rm -rf dist/ && ncc build --source-map --no-source-map-register src/index.ts","lint":"eslint .","format":"eslint --fix","docs":"rm -rf docs/ && typedoc --plugin typedoc-plugin-markdown","test":"node --require ts-node/register --test-reporter spec --test tests/download-util.test.ts tests/format-url.test.ts tests/index.test.ts"},"files":["dist/**/*"],"repository":{"type":"git","url":"git+https://github.com/google-github-actions/setup-cloud-sdk.git"},"keywords":["Cloud SDK","google cloud","gcloud"],"author":"Google LLC","license":"Apache-2.0","dependencies":{"@actions/core":"^1.11.1","@actions/exec":"^1.1.1","@actions/http-client":"^2.2.3","@actions/tool-cache":"^2.0.2","@google-github-actions/actions-utils":"^0.8.9","semver":"^7.7.2"},"devDependencies":{"@eslint/eslintrc":"^3.3.1","@eslint/js":"^9.34.0","@types/node":"^24.3.0","@types/semver":"^7.7.0","@typescript-eslint/eslint-plugin":"^8.40.0","@vercel/ncc":"^0.38.3","eslint-config-prettier":"^10.1.8","eslint-plugin-prettier":"^5.5.4","eslint":"^9.34.0","prettier":"^3.6.2","ts-node":"^10.9.2","typedoc-plugin-markdown":"^4.8.1","typedoc":"^0.28.10","typescript-eslint":"^8.40.0","typescript":"^5.9.2"}}');
module.exports = /*#__PURE__*/JSON.parse('{"name":"@google-github-actions/setup-cloud-sdk","version":"2.0.0","description":"Utilities to download, install, and interact with the Cloud SDK for GitHub Actions","module":"dist/index.js","main":"dist/index.js","types":"dist/index.d.js","engines":{"node":">= 24.x","npm":">= 11.x"},"scripts":{"build":"rm -rf dist/ && ncc build --source-map --no-source-map-register src/index.ts","lint":"eslint .","format":"eslint --fix","docs":"rm -rf docs/ && typedoc --plugin typedoc-plugin-markdown","test":"node --require ts-node/register --test-reporter spec --test tests/**/*.test.ts"},"files":["dist/**/*"],"repository":{"type":"git","url":"git+https://github.com/google-github-actions/setup-cloud-sdk.git"},"keywords":["Cloud SDK","google cloud","gcloud"],"author":"Google LLC","license":"Apache-2.0","dependencies":{"@actions/core":"^1.11.1","@actions/exec":"^1.1.1","@actions/http-client":"^2.2.3","@actions/tool-cache":"^2.0.2","@google-github-actions/actions-utils":"^1.0.0","semver":"^7.7.2"},"devDependencies":{"@eslint/eslintrc":"^3.3.1","@eslint/js":"^9.34.0","@types/node":"^24.3.0","@types/semver":"^7.7.0","@typescript-eslint/eslint-plugin":"^8.40.0","@vercel/ncc":"^0.38.3","eslint-config-prettier":"^10.1.8","eslint-plugin-prettier":"^5.5.4","eslint":"^9.34.0","prettier":"^3.6.2","ts-node":"^10.9.2","typedoc-plugin-markdown":"^4.8.1","typedoc":"^0.28.10","typescript-eslint":"^8.40.0","typescript":"^5.9.2"}}');

/***/ })

Expand Down
2 changes: 1 addition & 1 deletion dist/index.js.map

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/index/functions/authenticateGcloudSDK.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **authenticateGcloudSDK**(`filepath`): `Promise`\<`void`\>
Defined in: [index.ts:235](https://github.com/google-github-actions/setup-cloud-sdk/blob/main/src/index.ts#L235)
Defined in: [index.ts:239](https://github.com/google-github-actions/setup-cloud-sdk/blob/main/src/index.ts#L239)

Authenticates the gcloud tool using the provided credentials file.

Expand Down
2 changes: 1 addition & 1 deletion docs/index/functions/bestVersion.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **bestVersion**(`spec`): `Promise`\<`string`\>
Defined in: [index.ts:282](https://github.com/google-github-actions/setup-cloud-sdk/blob/main/src/index.ts#L282)
Defined in: [index.ts:286](https://github.com/google-github-actions/setup-cloud-sdk/blob/main/src/index.ts#L286)

bestVersion takes a version constraint and gets the latest available version
that satisfies the constraint.
Expand Down
2 changes: 1 addition & 1 deletion docs/index/functions/computeBestVersion.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **computeBestVersion**(`spec`, `versions`): `string`

Defined in: [index.ts:321](https://github.com/google-github-actions/setup-cloud-sdk/blob/main/src/index.ts#L321)
Defined in: [index.ts:325](https://github.com/google-github-actions/setup-cloud-sdk/blob/main/src/index.ts#L325)

computeBestVersion computes the latest available version that still satisfies
the spec. This is a helper function and is only exported for testing.
Expand Down
2 changes: 1 addition & 1 deletion docs/index/functions/computeGcloudVersion.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **computeGcloudVersion**(`version?`): `Promise`\<`string`\>
Defined in: [index.ts:222](https://github.com/google-github-actions/setup-cloud-sdk/blob/main/src/index.ts#L222)
Defined in: [index.ts:226](https://github.com/google-github-actions/setup-cloud-sdk/blob/main/src/index.ts#L226)

computeGcloudVersion computes the appropriate gcloud version for the given
string. If the string is the empty string or the special value "latest", it
Expand Down
2 changes: 1 addition & 1 deletion docs/index/functions/getLatestGcloudSDKVersion.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **getLatestGcloudSDKVersion**(): `Promise`\<`string`\>
Defined in: [index.ts:271](https://github.com/google-github-actions/setup-cloud-sdk/blob/main/src/index.ts#L271)
Defined in: [index.ts:275](https://github.com/google-github-actions/setup-cloud-sdk/blob/main/src/index.ts#L275)

getLatestGcloudSDKVersion fetches the latest version number from the API.

Expand Down
2 changes: 1 addition & 1 deletion docs/index/functions/installComponent.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **installComponent**(`component`): `Promise`\<`void`\>
Defined in: [index.ts:255](https://github.com/google-github-actions/setup-cloud-sdk/blob/main/src/index.ts#L255)
Defined in: [index.ts:259](https://github.com/google-github-actions/setup-cloud-sdk/blob/main/src/index.ts#L259)

Install a Cloud SDK component.

Expand Down
6 changes: 3 additions & 3 deletions docs/index/functions/installGcloudSDK.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# Function: installGcloudSDK()

> **installGcloudSDK**(`version`, `skipToolCache?`): `Promise`\<`string`\>
> **installGcloudSDK**(`version`, `useToolCache`): `Promise`\<`string`\>

Defined in: [index.ts:168](https://github.com/google-github-actions/setup-cloud-sdk/blob/main/src/index.ts#L168)

Expand All @@ -22,9 +22,9 @@ The version or version specification to install. If a
specification is given, the most recent version that still matches the
specification is installed.

### skipToolCache?
### useToolCache

`boolean`
`boolean` = `false`

## Returns

Expand Down
2 changes: 1 addition & 1 deletion docs/index/functions/setProject.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **setProject**(`projectId`): `Promise`\<`void`\>
Defined in: [index.ts:245](https://github.com/google-github-actions/setup-cloud-sdk/blob/main/src/index.ts#L245)
Defined in: [index.ts:249](https://github.com/google-github-actions/setup-cloud-sdk/blob/main/src/index.ts#L249)

Sets the GCP Project Id in the gcloud config.

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@google-github-actions/setup-cloud-sdk",
"version": "1.2.2",
"version": "2.0.0",
"description": "Utilities to download, install, and interact with the Cloud SDK for GitHub Actions",
"module": "dist/index.js",
"main": "dist/index.js",
Expand Down
Loading