google-github-actions / setup-cloud-sdk

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

Google GitHub actions: Setup Cloud SDK Client

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.

• Client API Reference

Table of contents:

• Installing the client library
• Using the client library
• Versioning
• Contributing
• License

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

setup-cloud-sdk's Issues

Support CLOUDSDK_AUTH_ACCESS_TOKEN for authentication

TL;DR

Support CLOUDSDK_AUTH_ACCESS_TOKEN

Detailed design

The CLI supports CLOUDSDK_AUTH_ACCESS_TOKEN, but the github action and the setup-cloud-sdk does not support it (from what I've experimented). Is there a way to authenticate with the $CLOUDSDK_AUTH_ACCESS_TOKEN or any other env variables?

Additional information

We would like to run google-github-actions/setup-gcloud with CLOUDSDK_AUTH_ACCESS_TOKEN and the Project ID. Unfortunately we cannot run the auth action but have to rely on a home grown solution to obtain a short lived credential.

Set user-agent when downloading the SDK

TL;DR

Set a custom user-agent to google-github-actions:setup-gcloud/version when downloading the SDK.

Expected behavior

No response

Observed behavior

No response

Action YAML

no: true

Log output

No response

Additional information

No response

Use --format json where possible

TL;DR

The current implementation relies heavily on parsing stdin/stdout. However, that isn't guaranteed to be stable. Where possible, we should switch to using machine-parseable output, including in tests.

Expected behavior

No response

Observed behavior

No response

Action YAML

not: applicable

Log output

No response

Additional information

No response

Refactor to use actions-utils

TL;DR

There are some parts here that we can refactor using actions-utils like parseServiceAccountKey, isWIFCredFile,

Detailed design

No response

Additional information

No response