configure-aws-credentials/src/cleanup/index.ts

import * as core from '@actions/core';
import { errorMessage, getBooleanInput } from '../helpers';

/**
 * When the GitHub Actions job is done, clean up any environment variables that
 * may have been set by the configure-aws-credentials steps in the job.
 *
 * Environment variables are not intended to be shared across different jobs in
 * the same GitHub Actions workflow: GitHub Actions documentation states that
 * each job runs in a fresh instance.  However, doing our own cleanup will
 * give us additional assurance that these environment variables are not shared
 * with any other jobs.
 */

export function cleanup() {
  // Only attempt to change environment variables if we changed them in the first place
  const awsProfile = core.getInput('aws-profile', { required: false });
  if (getBooleanInput('output-env-credentials', { required: false, default: !awsProfile })) {
    try {
      // The GitHub Actions toolkit does not have an option to completely unset
      // environment variables, so we overwrite the current value with an empty
      // string. The AWS CLI and AWS SDKs will behave correctly: they treat an
      // empty string value as if the environment variable does not exist.
      core.exportVariable('AWS_ACCESS_KEY_ID', '');
      core.exportVariable('AWS_SECRET_ACCESS_KEY', '');
      core.exportVariable('AWS_SESSION_TOKEN', '');
      core.exportVariable('AWS_DEFAULT_REGION', '');
      core.exportVariable('AWS_REGION', '');
      if (core.getInput('aws-profile')) {
        core.exportVariable('AWS_PROFILE', '');
      }
    } catch (error) {
      core.setFailed(errorMessage(error));
    }
  }
}

/* c8 ignore start */
if (require.main === module) {
  try {
    cleanup();
  } catch (error) {
    core.setFailed(errorMessage(error));
  }
}