utils

utils

This package contains utilities reusable in the actions implemented in this monorepo.

Usage

checkEnv(variables)

Use this function to check that required environment variables are set prior to executing the action.

const { checkEnv } = require('../../utils');

const run = async () => {
  checkEnv(['NEXUS_USERNAME', 'NEXUS_PASSWORD']);
}

This method throws an error if any of the provided variables are missing.

async gitConfig()

Use this function to configure the Git repository to push changes to GitHub using the GitHub Actions GITHUB_TOKEN.

const { gitConfig } = require('../../utils');

const run = async () => {
  await gitConfig();
  // From now on, it is possible to push to GitHub.
};

async loadTool ({ tool, binary, version, downloadUrl })

Use this function to load a tool into PATH. If the tool is cached, the cache is loaded, otherwise the tool is downloaded from the provided URL.

const { loadTool } = require('../../utils');

const run = async () => {
  const nuget = await loadTool({
    tool: 'nuget',
    binary: 'nuget.exe',
    version: '0.0.1-latest', // Version must be semver and 'latest' is not.
    downloadUrl: 'https://dist.nuget.org/win-x86-commandline/latest/nuget.exe',
  });
};

versions

A collection of functions to read and manipulate versions according to conventional commits.

Note that this script is not part of the utils main script and must be included from the src file. The reason for this is that it adds a lot of footprint to compiled scripts when used.

async getBuildVersion(versionSuffix = '')

Returns a promise with the version to build. This version number is determined by the last release number and the conventional commits after that release.

This method can append an optional suffix to the version, for example -SNAPSHOT.

const versions = require('../../utils/src/versions');

const run = async () => {
  const snapshotBuild = await getBuildVersion('-SNAPSHOT');
};

async getChangelog(version)

Returns a promise with a markdown formatted changelog for all conventional changes from the last release up until this commit.

const versions = require('../../utils/src/versions');

const run = async () => {
  const snapshotBuild = await getBuildVersion('-SNAPSHOT');
  const changes = await getChangelog(snapshotBuild);
};

async getConventionalCommits()

Returns a promise with an array of the conventional commits from the last release up until this commit.

const versions = require('../../utils/src/versions');

const run = async () => {
  const commits = await getConventionalCommits();
};

async getLatestRelease()

Returns a promise with the latest tagged release matching the tag prefix.

const { getLatestRelease } = require('../../.utils/src/versions');
const run = async () => {
  const latestRelease = await getLatestRelease();
};

setTagPrefix(prefix)

The tag prefix used for releases.

const versions = require('../../utils/src/versions');
versions.setTagPrefix('custom-');

async tagReleaseVersion()

Create a release tag and push it to origin. This function returns a promise with an object containing a markdown formatted changelog, the tagName and the version.

const { tagReleaseVersion } = require('../../.utils/src/versions');

const run = async () => {
  const release = await tagReleaseVersion();
  console.log('Tag name', release.tagName);
  console.log('Release version', release.version);
  console.log('Changes', release.changelog);
}

async getImageDigest(image)

Return a digest for the provided image.

const { getImageDigest } = require('../../.utils/src');

const run = async () => {
  const imageDigest = await getImageDigest('eu.gcr.io/my-image:tag123');
};