org.cyclonedx.gradle.utils

Class EnvironmentUtils

java.lang.Object

org.cyclonedx.gradle.utils.EnvironmentUtils

public class EnvironmentUtils
extends java.lang.Object

Utility class for working with environment variables in common CI environments.

Constructor Summary

Constructors

Constructor and Description
EnvironmentUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getBuildURI() Get the URI of the current build from the environment variables set on common build systems like GitHub Actions, GitLab CI, etc.
static java.lang.String	getBuildURI(java.lang.String str) Get the URI of the current build from the specified environment variable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EnvironmentUtils

public EnvironmentUtils()

Method Detail

getBuildURI

@Nullable
public static java.lang.String getBuildURI()

Get the URI of the current build from the environment variables set on common build systems like GitHub Actions, GitLab CI, etc.

Returns:

the URI of the current build or null if it cannot be determined

getBuildURI

@Nullable
public static java.lang.String getBuildURI(java.lang.String str)

Get the URI of the current build from the specified environment variable. Additionally, a pattern can be provided to extract the URI from the environment variable. An example pattern could be "${SERVER}/jobs/${JOB_ID}".

Parameters:

str - the name of the environment variable or pattern to use

Returns:

the URI of the current build or null if it cannot be determined