Skip to content

An NPM package for installing and configuring the Google Cloud SDK in GitHub Actions.

License

Notifications You must be signed in to change notification settings

google-github-actions/setup-cloud-sdk

Setup Cloud SDK for GitHub Actions API client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

Table of contents:

This is not an officially supported Google product, and it is not covered by a Google Cloud support contract. To report bugs or request features in a Google Cloud product, please contact Google Cloud support.

Installing the client library

npm install @google-github-actions/setup-cloud-sdk

Using the client library

import * as core from '@actions/core';
import * as toolCache from '@actions/tool-cache';
import * as setupGcloud from '@google-github-actions/setup-cloud-sdk';

// Install gcloud if not already installed.
const gcloudVersion = await setupGcloud.getLatestGcloudSDKVersion();

if (!setupGcloud.isInstalled(gcloudVersion)) {
  await setupGcloud.installGcloudSDK(gcloudVersion);
} else {
  const toolPath = toolCache.find('gcloud', gcloudVersion);
  core.addPath(path.join(toolPath, 'bin'));
}

// Authenticate gcloud SDK.
if (credentials) await setupGcloud.authenticateGcloudSDK(credentials);

const authenticated = await setupGcloud.isAuthenticated();
if (!authenticated) {
  throw new Error('Error authenticating the Cloud SDK.');
}

const toolCommand = setupGcloud.getToolCommand();

Versioning

This library follows Semantic Versioning.

Contributing

Contributions welcome! See the Contributing Guide.

License

Apache Version 2.0

See LICENSE