Package io.github.cdklabs.projen.github

Class GithubCredentials

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.github.GithubCredentials

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.082Z")
@Stability(Experimental)
public class GithubCredentials
extends software.amazon.jsii.JsiiObject

(experimental) Represents a method of providing GitHub API access for projen workflows.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GithubCredentials(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	GithubCredentials(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
static GithubCredentials	fromApp()	(experimental) Provide API access through a GitHub App.
static GithubCredentials	fromApp(GithubCredentialsAppOptions options)	(experimental) Provide API access through a GitHub App.
static GithubCredentials	fromPersonalAccessToken()	(experimental) Provide API access through a GitHub personal access token.
static GithubCredentials	fromPersonalAccessToken(GithubCredentialsPersonalAccessTokenOptions options)	(experimental) Provide API access through a GitHub personal access token.
List<JobStep>	getSetupSteps()	(experimental) Setup steps to obtain GitHub credentials.
String	getTokenRef()	(experimental) The value to use in a workflow when a GitHub token is expected.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

GithubCredentials

protected GithubCredentials(software.amazon.jsii.JsiiObjectRef objRef)

GithubCredentials

protected GithubCredentials(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

fromApp

@Stability(Experimental)
@NotNull
public static GithubCredentials fromApp(@Nullable
                                        GithubCredentialsAppOptions options)

(experimental) Provide API access through a GitHub App.

The GitHub App must be installed on the GitHub repo, its App ID and a private key must be added as secrets to the repo. The name of the secrets can be specified here.

Default: - app id stored in "PROJEN_APP_ID" and private key stored in "PROJEN_APP_PRIVATE_KEY" with all permissions attached to the app

Parameters:

options -

See Also:

https://projen.io/github.html#github-app

fromApp

@Stability(Experimental)
@NotNull
public static GithubCredentials fromApp()

(experimental) Provide API access through a GitHub App.

The GitHub App must be installed on the GitHub repo, its App ID and a private key must be added as secrets to the repo. The name of the secrets can be specified here.

Default: - app id stored in "PROJEN_APP_ID" and private key stored in "PROJEN_APP_PRIVATE_KEY" with all permissions attached to the app

See Also:

https://projen.io/github.html#github-app

fromPersonalAccessToken

@Stability(Experimental)
@NotNull
public static GithubCredentials fromPersonalAccessToken(@Nullable
                                                        GithubCredentialsPersonalAccessTokenOptions options)

(experimental) Provide API access through a GitHub personal access token.

The token must be added as a secret to the GitHub repo, and the name of the secret can be specified here.

Default: - a secret named "PROJEN_GITHUB_TOKEN"

Parameters:

options -

See Also:

https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token

fromPersonalAccessToken

@Stability(Experimental)
@NotNull
public static GithubCredentials fromPersonalAccessToken()

(experimental) Provide API access through a GitHub personal access token.

The token must be added as a secret to the GitHub repo, and the name of the secret can be specified here.

Default: - a secret named "PROJEN_GITHUB_TOKEN"

See Also:

https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token

getSetupSteps

@Stability(Experimental)
@NotNull
public List<JobStep> getSetupSteps()

(experimental) Setup steps to obtain GitHub credentials.

getTokenRef

@Stability(Experimental)
@NotNull
public String getTokenRef()

(experimental) The value to use in a workflow when a GitHub token is expected.

This typically looks like "${{ some.path.to.a.value }}".