jsii-release

constructor

constructor(props: GoReleaserProps);

method release

release: () => GoRelease;

• Run the release process.

  Returns

  metadata about the release.

property cannonicalName

readonly cannonicalName: string;

• The cannonical name of the module. (e.g 'github.com/aws/constructs-go/constructs/v3`)

property modFile

readonly modFile: string;

• Path to the mod file.

property repoPath

readonly repoPath: string;

• The path inside the repository the module is located in. (e.g 'constructs')

property repoURL

readonly repoURL: string;

• The repository URL. (e.g 'github.com/aws/constructs')

property version

readonly version: string;

• The version of the module.

property commitMessage

readonly commitMessage?: string;

• The commit message of the release.

property repoDir

readonly repoDir?: string;

• The directory where the repository was released from.

property tags

readonly tags?: string[];

• The tags the release created.

property branch

readonly branch?: string;

• The branch to push to.

  'main'

property cloneDepth

readonly cloneDepth?: number;

• The git clone depth.

  Usually only the latest commit is required.

  1

property dir

readonly dir?: string;

• The source code directory.

  'dist/go'

property dryRun

readonly dryRun?: boolean;

• Execute a dry run only.

  false

property email

readonly email?: string;

• The email to use for the commit.

  - taken from git config. throws if not configured.

property message

readonly message?: string;

• The message to use for the commit marking the release.

property username

readonly username?: string;

• The username to use for the commit.

  - taken from git config. throws if not configured.

property version

readonly version?: string;

• The version.

  - taken from the 'version'. throws if doesn't exist.