`release` Submodule

Constructs

Publisher

Implements GitHub jobs for publishing modules to package managers.

Under the hood, it uses https://github.com/aws/publib

Initializers

import { release } from 'projen'

new release.Publisher(project: Project, options: PublisherOptions)

Name	Type	Description
`project`	`projen.Project`	No description.
`options`	`PublisherOptions`	No description.

`project`^Required

Type: projen.Project

`options`^Required

Type: PublisherOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`synthesize`	Synthesizes files to the project output directory.
`addGitHubPostPublishingSteps`	Adds post publishing steps for the GitHub release job.
`addGitHubPrePublishingSteps`	Adds pre publishing steps for the GitHub release job.
`publishToGit`	Publish to git.
`publishToGitHubReleases`	Creates a GitHub Release.
`publishToGo`	Adds a go publishing job.
`publishToMaven`	Publishes artifacts from `java/**` to Maven.
`publishToNpm`	Publishes artifacts from `js/**` to npm.
`publishToNuget`	Publishes artifacts from `dotnet/**` to NuGet Gallery.
`publishToPyPi`	Publishes wheel artifacts from `python` to PyPI.

`toString`

public toString(): string

Returns a string representation of this construct.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`synthesize`

public synthesize(): void

Synthesizes files to the project output directory.

`addGitHubPostPublishingSteps`

public addGitHubPostPublishingSteps(steps: ...JobStep[]): void

Adds post publishing steps for the GitHub release job.

`steps`^Required

Type: ...projen.github.workflows.JobStep[]

The steps.

`addGitHubPrePublishingSteps`

public addGitHubPrePublishingSteps(steps: ...JobStep[]): void

Adds pre publishing steps for the GitHub release job.

`steps`^Required

Type: ...projen.github.workflows.JobStep[]

The steps.

`publishToGit`

public publishToGit(options: GitPublishOptions): Task

Publish to git.

This includes generating a project-level changelog and release tags.

`options`^Required

Type: GitPublishOptions

Options.

`publishToGitHubReleases`

public publishToGitHubReleases(options: GitHubReleasesPublishOptions): void

Creates a GitHub Release.

`options`^Required

Type: GitHubReleasesPublishOptions

Options.

`publishToGo`

public publishToGo(options?: GoPublishOptions): void

Adds a go publishing job.

`options`^Optional

Type: GoPublishOptions

Options.

`publishToMaven`

public publishToMaven(options?: MavenPublishOptions): void

Publishes artifacts from java/** to Maven.

`options`^Optional

Type: MavenPublishOptions

Options.

`publishToNpm`

public publishToNpm(options?: NpmPublishOptions): void

Publishes artifacts from js/** to npm.

`options`^Optional

Type: NpmPublishOptions

Options.

`publishToNuget`

public publishToNuget(options?: NugetPublishOptions): void

Publishes artifacts from dotnet/** to NuGet Gallery.

`options`^Optional

Type: NugetPublishOptions

Options.

`publishToPyPi`

public publishToPyPi(options?: PyPiPublishOptions): void

Publishes wheel artifacts from python to PyPI.

`options`^Optional

Type: PyPiPublishOptions

Options.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { release } from 'projen'

release.Publisher.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`x`^Required

Type: any

Any object.

`isComponent`

import { release } from 'projen'

release.Publisher.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`projen.Project`	No description.
`artifactName`	`string`	No description.
`buildJobId`	`string`	No description.
`jsiiReleaseVersion`	`string`	No description.
`publibVersion`	`string`	No description.
`condition`	`string`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: projen.Project

`artifactName`^Required

public readonly artifactName: string;

Type: string

`buildJobId`^Required

public readonly buildJobId: string;

Type: string

`jsiiReleaseVersion`^Required

Deprecated: use publibVersion

public readonly jsiiReleaseVersion: string;

Type: string

`publibVersion`^Required

public readonly publibVersion: string;

Type: string

`condition`^Optional

public readonly condition: string;

Type: string

Constants

Name	Type	Description
`PUBLISH_GIT_TASK_NAME`	`string`	No description.

`PUBLISH_GIT_TASK_NAME`^Required

public readonly PUBLISH_GIT_TASK_NAME: string;

Type: string

Release

Manages releases (currently through GitHub workflows).

By default, no branches are released. To add branches, call addBranch().

Initializers

import { release } from 'projen'

new release.Release(scope: IConstruct, options: ReleaseOptions)

Name	Type	Description
`scope`	`constructs.IConstruct`	should be part of the project the Release belongs to.
`options`	`ReleaseOptions`	options to configure the Release Component.

`scope`^Required

Type: constructs.IConstruct

should be part of the project the Release belongs to.

`options`^Required

Type: ReleaseOptions

options to configure the Release Component.

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`synthesize`	Synthesizes files to the project output directory.
`addBranch`	Adds a release branch.
`addJobs`	Adds jobs to all release workflows.

`toString`

public toString(): string

Returns a string representation of this construct.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`synthesize`

public synthesize(): void

Synthesizes files to the project output directory.

`addBranch`

public addBranch(branch: string, options: BranchOptions): void

Adds a release branch.

It is a git branch from which releases are published. If a project has more than one release branch, we require that majorVersion is also specified for the primary branch in order to ensure branches always release the correct version.

`branch`^Required

Type: string

The branch to monitor (e.g. main, v2.x).

`options`^Required

Type: BranchOptions

Branch definition.

`addJobs`

public addJobs(jobs: {[ key: string ]: Job}): void

Adds jobs to all release workflows.

`jobs`^Required

Type: {[ key: string ]: projen.github.workflows.Job}

The jobs to add (name => job).

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.
`of`	Returns the `Release` component of a project or `undefined` if the project does not have a Release component.

`isConstruct`

import { release } from 'projen'

release.Release.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isComponent`

import { release } from 'projen'

release.Release.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

`of`

import { release } from 'projen'

release.Release.of(project: Project)

Returns the Release component of a project or undefined if the project does not have a Release component.

`project`^Required

Type: projen.Project

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`projen.Project`	No description.
`artifactsDirectory`	`string`	Location of build artifacts.
`branches`	`string[]`	Retrieve all release branch names.
`publisher`	`Publisher`	Package publisher.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: projen.Project

`artifactsDirectory`^Required

public readonly artifactsDirectory: string;

Type: string

Location of build artifacts.

`branches`^Required

public readonly branches: string[];

Type: string[]

Retrieve all release branch names.

`publisher`^Required

public readonly publisher: Publisher;

Type: Publisher

Package publisher.

Constants

Name	Type	Description
`ANTI_TAMPER_CMD`	`string`	No description.

`ANTI_TAMPER_CMD`^Required

public readonly ANTI_TAMPER_CMD: string;

Type: string

Structs

BranchOptions

Options for a release branch.

Initializer

import { release } from 'projen'

const branchOptions: release.BranchOptions = { ... }

Properties

Name	Type	Description
`majorVersion`	`number`	The major versions released from this branch.
`environment`	`string`	The GitHub Actions environment used for the release.
`minMajorVersion`	`number`	The minimum major version to release.
`minorVersion`	`number`	The minor versions released from this branch.
`npmDistTag`	`string`	The npm distribution tag to use for this branch.
`prerelease`	`string`	Bump the version as a pre-release tag.
`tagPrefix`	`string`	Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
`workflowName`	`string`	The name of the release workflow.

`majorVersion`^Required

public readonly majorVersion: number;

Type: number

The major versions released from this branch.

`environment`^Optional

public readonly environment: string;

Type: string
Default: no environment used, unless set at the artifact level

The GitHub Actions environment used for the release.

This can be used to add an explicit approval step to the release or limit who can initiate a release through environment protection rules.

When multiple artifacts are released, the environment can be overwritten on a per artifact basis.

`minMajorVersion`^Optional

public readonly minMajorVersion: number;

Type: number

The minimum major version to release.

`minorVersion`^Optional

public readonly minorVersion: number;

Type: number

The minor versions released from this branch.

`npmDistTag`^Optional

public readonly npmDistTag: string;

Type: string
Default: "latest"

The npm distribution tag to use for this branch.

`prerelease`^Optional

public readonly prerelease: string;

Type: string
Default: normal releases

Bump the version as a pre-release tag.

`tagPrefix`^Optional

public readonly tagPrefix: string;

Type: string
Default: no prefix

Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.

Note: this prefix is used to detect the latest tagged version when bumping, so if you change this on a project with an existing version history, you may need to manually tag your latest release with the new prefix.

`workflowName`^Optional

public readonly workflowName: string;

Type: string
Default: "release-BRANCH"

The name of the release workflow.

CodeArtifactOptions

Options for publishing packages to AWS CodeArtifact.

Initializer

import { release } from 'projen'

const codeArtifactOptions: release.CodeArtifactOptions = { ... }

Properties

Name	Type	Description
`accessKeyIdSecret`	`string`	GitHub secret which contains the AWS access key ID to use when publishing packages to AWS CodeArtifact.
`authProvider`	`CodeArtifactAuthProvider`	Provider to use for authorizing requests to AWS CodeArtifact.
`roleToAssume`	`string`	ARN of AWS role to be assumed prior to get authorization token from AWS CodeArtifact This property must be specified only when publishing to AWS CodeArtifact (`registry` contains AWS CodeArtifact URL).
`secretAccessKeySecret`	`string`	GitHub secret which contains the AWS secret access key to use when publishing packages to AWS CodeArtifact.

`accessKeyIdSecret`^Optional

public readonly accessKeyIdSecret: string;

Type: string
Default: When the authProvider value is set to CodeArtifactAuthProvider.ACCESS_AND_SECRET_KEY_PAIR, the default is "AWS_ACCESS_KEY_ID". For CodeArtifactAuthProvider.GITHUB_OIDC, this value must be left undefined.

GitHub secret which contains the AWS access key ID to use when publishing packages to AWS CodeArtifact.

This property must be specified only when publishing to AWS CodeArtifact (npmRegistryUrl contains AWS CodeArtifact URL).

`authProvider`^Optional

public readonly authProvider: CodeArtifactAuthProvider;

Type: CodeArtifactAuthProvider
Default: CodeArtifactAuthProvider.ACCESS_AND_SECRET_KEY_PAIR

Provider to use for authorizing requests to AWS CodeArtifact.

`roleToAssume`^Optional

public readonly roleToAssume: string;

Type: string
Default: undefined

ARN of AWS role to be assumed prior to get authorization token from AWS CodeArtifact This property must be specified only when publishing to AWS CodeArtifact (registry contains AWS CodeArtifact URL).

When using the CodeArtifactAuthProvider.GITHUB_OIDC auth provider, this value must be defined.

`secretAccessKeySecret`^Optional

public readonly secretAccessKeySecret: string;

Type: string
Default: When the authProvider value is set to CodeArtifactAuthProvider.ACCESS_AND_SECRET_KEY_PAIR, the default is "AWS_SECRET_ACCESS_KEY". For CodeArtifactAuthProvider.GITHUB_OIDC, this value must be left undefined.

GitHub secret which contains the AWS secret access key to use when publishing packages to AWS CodeArtifact.

This property must be specified only when publishing to AWS CodeArtifact (npmRegistryUrl contains AWS CodeArtifact URL).

CommonPublishOptions

Common publishing options.

Initializer

import { release } from 'projen'

const commonPublishOptions: release.CommonPublishOptions = { ... }

Properties

Name	Type	Description
`githubEnvironment`	`string`	The GitHub Actions environment used for publishing.
`postPublishSteps`	`projen.github.workflows.JobStep[]`	Steps to execute after executing the publishing command.
`prePublishSteps`	`projen.github.workflows.JobStep[]`	Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if needed.
`publishTools`	`projen.github.workflows.Tools`	Additional tools to install in the publishing job.

`githubEnvironment`^Optional

public readonly githubEnvironment: string;

Type: string
Default: no environment used, unless set at the package level

The GitHub Actions environment used for publishing.

This can be used to add an explicit approval step to the release or limit who can initiate a release through environment protection rules.

Set this to overwrite a package level publishing environment just for this artifact.

`postPublishSteps`^Optional

public readonly postPublishSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

Steps to execute after executing the publishing command.

These can be used to add/update the release artifacts ot any other tasks needed.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPostPublishingSteps.

`prePublishSteps`^Optional

public readonly prePublishSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if needed.

These steps are executed after dist/ has been populated with the build output.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPrePublishingSteps.

`publishTools`^Optional

public readonly publishTools: Tools;

Type: projen.github.workflows.Tools
Default: no additional tools are installed

Additional tools to install in the publishing job.

ContinuousReleaseOptions

Initializer

import { release } from 'projen'

const continuousReleaseOptions: release.ContinuousReleaseOptions = { ... }

Properties

Name	Type	Description
`paths`	`string[]`	Paths for which pushes should trigger a release.

`paths`^Optional

public readonly paths: string[];

Type: string[]

Paths for which pushes should trigger a release.

GitHubReleasesPublishOptions

Publishing options for GitHub releases.

Initializer

import { release } from 'projen'

const gitHubReleasesPublishOptions: release.GitHubReleasesPublishOptions = { ... }

Properties

Name	Type	Description
`githubEnvironment`	`string`	The GitHub Actions environment used for publishing.
`postPublishSteps`	`projen.github.workflows.JobStep[]`	Steps to execute after executing the publishing command.
`prePublishSteps`	`projen.github.workflows.JobStep[]`	Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if needed.
`publishTools`	`projen.github.workflows.Tools`	Additional tools to install in the publishing job.
`changelogFile`	`string`	The location of an .md file (relative to `dist/`) that includes the changelog for the release.
`releaseTagFile`	`string`	The location of a text file (relative to `dist/`) that contains the release tag.
`versionFile`	`string`	The location of a text file (relative to `dist/`) that contains the version number.

`githubEnvironment`^Optional

public readonly githubEnvironment: string;

Type: string
Default: no environment used, unless set at the package level

The GitHub Actions environment used for publishing.

This can be used to add an explicit approval step to the release or limit who can initiate a release through environment protection rules.

Set this to overwrite a package level publishing environment just for this artifact.

`postPublishSteps`^Optional

public readonly postPublishSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

Steps to execute after executing the publishing command.

These can be used to add/update the release artifacts ot any other tasks needed.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPostPublishingSteps.

`prePublishSteps`^Optional

public readonly prePublishSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if needed.

These steps are executed after dist/ has been populated with the build output.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPrePublishingSteps.

`publishTools`^Optional

public readonly publishTools: Tools;

Type: projen.github.workflows.Tools
Default: no additional tools are installed

Additional tools to install in the publishing job.

`changelogFile`^Required

public readonly changelogFile: string;

Type: string

The location of an .md file (relative to dist/) that includes the changelog for the release.

Example

changelog.md

`releaseTagFile`^Required

public readonly releaseTagFile: string;

Type: string

The location of a text file (relative to dist/) that contains the release tag.

Example

releasetag.txt

`versionFile`^Required

public readonly versionFile: string;

Type: string

The location of a text file (relative to dist/) that contains the version number.

Example

version.txt

GitPublishOptions

Publishing options for Git releases.

Initializer

import { release } from 'projen'

const gitPublishOptions: release.GitPublishOptions = { ... }

Properties

Name	Type	Description
`changelogFile`	`string`	The location of an .md file (relative to `dist/`) that includes the changelog for the release.
`releaseTagFile`	`string`	The location of a text file (relative to `dist/`) that contains the release tag.
`versionFile`	`string`	The location of a text file (relative to `dist/`) that contains the version number.
`gitBranch`	`string`	Branch to push to.
`gitPushCommand`	`string`	Override git-push command.
`projectChangelogFile`	`string`	The location of an .md file that includes the project-level changelog.

`changelogFile`^Required

public readonly changelogFile: string;

Type: string

The location of an .md file (relative to dist/) that includes the changelog for the release.

Example

changelog.md

`releaseTagFile`^Required

public readonly releaseTagFile: string;

Type: string

The location of a text file (relative to dist/) that contains the release tag.

Example

releasetag.txt

`versionFile`^Required

public readonly versionFile: string;

Type: string

The location of a text file (relative to dist/) that contains the version number.

Example

version.txt

`gitBranch`^Optional

public readonly gitBranch: string;

Type: string
Default: "main"

Branch to push to.

`gitPushCommand`^Optional

public readonly gitPushCommand: string;

Type: string

Override git-push command.

Set to an empty string to disable pushing.

`projectChangelogFile`^Optional

public readonly projectChangelogFile: string;

Type: string

The location of an .md file that includes the project-level changelog.

GoPublishOptions

Options for Go releases.

Initializer

import { release } from 'projen'

const goPublishOptions: release.GoPublishOptions = { ... }

Properties

Name	Type	Description
`githubEnvironment`	`string`	The GitHub Actions environment used for publishing.
`postPublishSteps`	`projen.github.workflows.JobStep[]`	Steps to execute after executing the publishing command.
`prePublishSteps`	`projen.github.workflows.JobStep[]`	Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if needed.
`publishTools`	`projen.github.workflows.Tools`	Additional tools to install in the publishing job.
`gitBranch`	`string`	Branch to push to.
`gitCommitMessage`	`string`	The commit message.
`githubDeployKeySecret`	`string`	The name of the secret that includes a GitHub deploy key used to push to the GitHub repository.
`githubTokenSecret`	`string`	The name of the secret that includes a personal GitHub access token used to push to the GitHub repository.
`githubUseSsh`	`boolean`	Use SSH to push to GitHub instead of a personal accses token.
`gitUserEmail`	`string`	The email to use in the release git commit.
`gitUserName`	`string`	The user name to use for the release git commit.

`githubEnvironment`^Optional

public readonly githubEnvironment: string;

Type: string
Default: no environment used, unless set at the package level

The GitHub Actions environment used for publishing.

This can be used to add an explicit approval step to the release or limit who can initiate a release through environment protection rules.

Set this to overwrite a package level publishing environment just for this artifact.

`postPublishSteps`^Optional

public readonly postPublishSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

Steps to execute after executing the publishing command.

These can be used to add/update the release artifacts ot any other tasks needed.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPostPublishingSteps.

`prePublishSteps`^Optional

public readonly prePublishSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if needed.

These steps are executed after dist/ has been populated with the build output.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPrePublishingSteps.

`publishTools`^Optional

public readonly publishTools: Tools;

Type: projen.github.workflows.Tools
Default: no additional tools are installed

Additional tools to install in the publishing job.

`gitBranch`^Optional

public readonly gitBranch: string;

Type: string
Default: "main"

Branch to push to.

`gitCommitMessage`^Optional

public readonly gitCommitMessage: string;

Type: string
Default: "chore(release): $VERSION"

The commit message.

`githubDeployKeySecret`^Optional

public readonly githubDeployKeySecret: string;

Type: string
Default: "GO_GITHUB_DEPLOY_KEY"

The name of the secret that includes a GitHub deploy key used to push to the GitHub repository.

Ignored if githubUseSsh is false.

`githubTokenSecret`^Optional

public readonly githubTokenSecret: string;

Type: string
Default: "GO_GITHUB_TOKEN"

The name of the secret that includes a personal GitHub access token used to push to the GitHub repository.

Ignored if githubUseSsh is true.

`githubUseSsh`^Optional

public readonly githubUseSsh: boolean;

Type: boolean
Default: false

Use SSH to push to GitHub instead of a personal accses token.

`gitUserEmail`^Optional

public readonly gitUserEmail: string;

Type: string
Default: default GitHub Actions user email

The email to use in the release git commit.

`gitUserName`^Optional

public readonly gitUserName: string;

Type: string
Default: default GitHub Actions user name

The user name to use for the release git commit.

JsiiReleaseGo

Initializer

import { release } from 'projen'

const jsiiReleaseGo: release.JsiiReleaseGo = { ... }

Properties

Name	Type	Description
`githubEnvironment`	`string`	The GitHub Actions environment used for publishing.
`postPublishSteps`	`projen.github.workflows.JobStep[]`	Steps to execute after executing the publishing command.
`prePublishSteps`	`projen.github.workflows.JobStep[]`	Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if needed.
`publishTools`	`projen.github.workflows.Tools`	Additional tools to install in the publishing job.
`gitBranch`	`string`	Branch to push to.
`gitCommitMessage`	`string`	The commit message.
`githubDeployKeySecret`	`string`	The name of the secret that includes a GitHub deploy key used to push to the GitHub repository.
`githubTokenSecret`	`string`	The name of the secret that includes a personal GitHub access token used to push to the GitHub repository.
`githubUseSsh`	`boolean`	Use SSH to push to GitHub instead of a personal accses token.
`gitUserEmail`	`string`	The email to use in the release git commit.
`gitUserName`	`string`	The user name to use for the release git commit.

`githubEnvironment`^Optional

Deprecated: Use GoPublishOptions instead.

public readonly githubEnvironment: string;

Type: string
Default: no environment used, unless set at the package level

The GitHub Actions environment used for publishing.

This can be used to add an explicit approval step to the release or limit who can initiate a release through environment protection rules.

Set this to overwrite a package level publishing environment just for this artifact.

`postPublishSteps`^Optional

Deprecated: Use GoPublishOptions instead.

public readonly postPublishSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

Steps to execute after executing the publishing command.

These can be used to add/update the release artifacts ot any other tasks needed.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPostPublishingSteps.

`prePublishSteps`^Optional

Deprecated: Use GoPublishOptions instead.

public readonly prePublishSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if needed.

These steps are executed after dist/ has been populated with the build output.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPrePublishingSteps.

`publishTools`^Optional

Deprecated: Use GoPublishOptions instead.

public readonly publishTools: Tools;

Type: projen.github.workflows.Tools
Default: no additional tools are installed

Additional tools to install in the publishing job.

`gitBranch`^Optional

Deprecated: Use GoPublishOptions instead.

public readonly gitBranch: string;

Type: string
Default: "main"

Branch to push to.

`gitCommitMessage`^Optional

Deprecated: Use GoPublishOptions instead.

public readonly gitCommitMessage: string;

Type: string
Default: "chore(release): $VERSION"

The commit message.

`githubDeployKeySecret`^Optional

Deprecated: Use GoPublishOptions instead.

public readonly githubDeployKeySecret: string;

Type: string
Default: "GO_GITHUB_DEPLOY_KEY"

The name of the secret that includes a GitHub deploy key used to push to the GitHub repository.

Ignored if githubUseSsh is false.

`githubTokenSecret`^Optional

Deprecated: Use GoPublishOptions instead.

public readonly githubTokenSecret: string;

Type: string
Default: "GO_GITHUB_TOKEN"

The name of the secret that includes a personal GitHub access token used to push to the GitHub repository.

Ignored if githubUseSsh is true.

`githubUseSsh`^Optional

Deprecated: Use GoPublishOptions instead.

public readonly githubUseSsh: boolean;

Type: boolean
Default: false

Use SSH to push to GitHub instead of a personal accses token.

`gitUserEmail`^Optional

Deprecated: Use GoPublishOptions instead.

public readonly gitUserEmail: string;

Type: string
Default: default GitHub Actions user email

The email to use in the release git commit.

`gitUserName`^Optional

Deprecated: Use GoPublishOptions instead.

public readonly gitUserName: string;

Type: string
Default: default GitHub Actions user name

The user name to use for the release git commit.

JsiiReleaseMaven

Initializer

import { release } from 'projen'

const jsiiReleaseMaven: release.JsiiReleaseMaven = { ... }

Properties

Name	Type	Description
`githubEnvironment`	`string`	The GitHub Actions environment used for publishing.
`postPublishSteps`	`projen.github.workflows.JobStep[]`	Steps to execute after executing the publishing command.
`prePublishSteps`	`projen.github.workflows.JobStep[]`	Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if needed.
`publishTools`	`projen.github.workflows.Tools`	Additional tools to install in the publishing job.
`mavenEndpoint`	`string`	URL of Nexus repository.
`mavenGpgPrivateKeyPassphrase`	`string`	GitHub secret name which contains the GPG private key or file that includes it.
`mavenGpgPrivateKeySecret`	`string`	GitHub secret name which contains the GPG private key or file that includes it.
`mavenPassword`	`string`	GitHub secret name which contains the Password for maven repository.
`mavenRepositoryUrl`	`string`	Deployment repository when not deploying to Maven Central.
`mavenServerId`	`string`	Used in maven settings for credential lookup (e.g. use github when publishing to GitHub).
`mavenStagingProfileId`	`string`	GitHub secret name which contains the Maven Central (sonatype) staging profile ID (e.g. 68a05363083174). Staging profile ID can be found in the URL of the "Releases" staging profile under "Staging Profiles" in https://oss.sonatype.org (e.g. https://oss.sonatype.org/#stagingProfiles;11a33451234521).
`mavenUsername`	`string`	GitHub secret name which contains the Username for maven repository.

`githubEnvironment`^Optional

Deprecated: Use MavenPublishOptions instead.

public readonly githubEnvironment: string;

Type: string
Default: no environment used, unless set at the package level

The GitHub Actions environment used for publishing.

This can be used to add an explicit approval step to the release or limit who can initiate a release through environment protection rules.

Set this to overwrite a package level publishing environment just for this artifact.

`postPublishSteps`^Optional

Deprecated: Use MavenPublishOptions instead.

public readonly postPublishSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

Steps to execute after executing the publishing command.

These can be used to add/update the release artifacts ot any other tasks needed.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPostPublishingSteps.

`prePublishSteps`^Optional

Deprecated: Use MavenPublishOptions instead.

public readonly prePublishSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if needed.

These steps are executed after dist/ has been populated with the build output.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPrePublishingSteps.

`publishTools`^Optional

Deprecated: Use MavenPublishOptions instead.

public readonly publishTools: Tools;

Type: projen.github.workflows.Tools
Default: no additional tools are installed

Additional tools to install in the publishing job.

`mavenEndpoint`^Optional

Deprecated: Use MavenPublishOptions instead.

public readonly mavenEndpoint: string;

Type: string
Default: "https://oss.sonatype.org" or none when publishing to Maven Central

URL of Nexus repository.

if not set, defaults to https://oss.sonatype.org

`mavenGpgPrivateKeyPassphrase`^Optional

Deprecated: Use MavenPublishOptions instead.

public readonly mavenGpgPrivateKeyPassphrase: string;

Type: string
Default: "MAVEN_GPG_PRIVATE_KEY_PASSPHRASE" or not set when using GitHub Packages

GitHub secret name which contains the GPG private key or file that includes it.

This is used to sign your Maven packages. See instructions.

https://github.com/aws/publib#maven

`mavenGpgPrivateKeySecret`^Optional

Deprecated: Use MavenPublishOptions instead.

public readonly mavenGpgPrivateKeySecret: string;

Type: string
Default: "MAVEN_GPG_PRIVATE_KEY" or not set when using GitHub Packages

GitHub secret name which contains the GPG private key or file that includes it.

This is used to sign your Maven packages. See instructions.

https://github.com/aws/publib#maven

`mavenPassword`^Optional

Deprecated: Use MavenPublishOptions instead.

public readonly mavenPassword: string;

Type: string
Default: "MAVEN_PASSWORD" or "GITHUB_TOKEN" when using GitHub Packages

GitHub secret name which contains the Password for maven repository.

For Maven Central, you will need to Create JIRA account and then request a new project (see links).

https://issues.sonatype.org/secure/CreateIssue.jspa?issuetype=21&pid=10134

`mavenRepositoryUrl`^Optional

Deprecated: Use MavenPublishOptions instead.

public readonly mavenRepositoryUrl: string;

Type: string
Default: not set

Deployment repository when not deploying to Maven Central.

`mavenServerId`^Optional

Deprecated: Use MavenPublishOptions instead.

public readonly mavenServerId: string;

Type: string
Default: "ossrh" (Maven Central) or "github" when using GitHub Packages

Used in maven settings for credential lookup (e.g. use github when publishing to GitHub).

Set to central-ossrh to publish to Maven Central.

`mavenStagingProfileId`^Optional

Deprecated: Use MavenPublishOptions instead.

public readonly mavenStagingProfileId: string;

Type: string
Default: "MAVEN_STAGING_PROFILE_ID" or not set when using GitHub Packages

GitHub secret name which contains the Maven Central (sonatype) staging profile ID (e.g. 68a05363083174). Staging profile ID can be found in the URL of the "Releases" staging profile under "Staging Profiles" in https://oss.sonatype.org (e.g. https://oss.sonatype.org/#stagingProfiles;11a33451234521).

`mavenUsername`^Optional

Deprecated: Use MavenPublishOptions instead.

public readonly mavenUsername: string;

Type: string
Default: "MAVEN_USERNAME" or the GitHub Actor when using GitHub Packages

GitHub secret name which contains the Username for maven repository.

For Maven Central, you will need to Create JIRA account and then request a new project (see links).

https://issues.sonatype.org/secure/CreateIssue.jspa?issuetype=21&pid=10134

JsiiReleaseNpm

Initializer

import { release } from 'projen'

const jsiiReleaseNpm: release.JsiiReleaseNpm = { ... }

Properties

Name	Type	Description
`githubEnvironment`	`string`	The GitHub Actions environment used for publishing.
`postPublishSteps`	`projen.github.workflows.JobStep[]`	Steps to execute after executing the publishing command.
`prePublishSteps`	`projen.github.workflows.JobStep[]`	Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if needed.
`publishTools`	`projen.github.workflows.Tools`	Additional tools to install in the publishing job.
`codeArtifactOptions`	`CodeArtifactOptions`	Options for publishing npm package to AWS CodeArtifact.
`distTag`	`string`	Tags can be used to provide an alias instead of version numbers.
`npmProvenance`	`boolean`	Should provenance statements be generated when package is published.
`npmTokenSecret`	`string`	GitHub secret which contains the NPM token to use for publishing packages.
`registry`	`string`	The domain name of the npm package registry.
`trustedPublishing`	`boolean`	Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.

`githubEnvironment`^Optional

Deprecated: Use NpmPublishOptions instead.

public readonly githubEnvironment: string;

Type: string
Default: no environment used, unless set at the package level

The GitHub Actions environment used for publishing.

This can be used to add an explicit approval step to the release or limit who can initiate a release through environment protection rules.

Set this to overwrite a package level publishing environment just for this artifact.

`postPublishSteps`^Optional

Deprecated: Use NpmPublishOptions instead.

public readonly postPublishSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

Steps to execute after executing the publishing command.

These can be used to add/update the release artifacts ot any other tasks needed.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPostPublishingSteps.

`prePublishSteps`^Optional

Deprecated: Use NpmPublishOptions instead.

public readonly prePublishSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if needed.

These steps are executed after dist/ has been populated with the build output.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPrePublishingSteps.

`publishTools`^Optional

Deprecated: Use NpmPublishOptions instead.

public readonly publishTools: Tools;

Type: projen.github.workflows.Tools
Default: no additional tools are installed

Additional tools to install in the publishing job.

`codeArtifactOptions`^Optional

Deprecated: Use NpmPublishOptions instead.

public readonly codeArtifactOptions: CodeArtifactOptions;

Type: CodeArtifactOptions
Default: package is not published to

Options for publishing npm package to AWS CodeArtifact.

`distTag`^Optional

Deprecated: Use npmDistTag for each release branch instead.

public readonly distTag: string;

Type: string
Default: "latest"

Tags can be used to provide an alias instead of version numbers.

For example, a project might choose to have multiple streams of development and use a different tag for each stream, e.g., stable, beta, dev, canary.

By default, the latest tag is used by npm to identify the current version of a package, and npm install <pkg> (without any @<version> or @<tag> specifier) installs the latest tag. Typically, projects only use the latest tag for stable release versions, and use other tags for unstable versions such as prereleases.

The next tag is used by some projects to identify the upcoming version.

`npmProvenance`^Optional

Deprecated: Use NpmPublishOptions instead.

public readonly npmProvenance: boolean;

Type: boolean
Default: enabled for for public packages using trusted publishing, disabled otherwise

Should provenance statements be generated when package is published.

Note that this component is using publib to publish packages, which is using npm internally and supports provenance statements independently of the package manager used.

Only works in supported CI/CD environments.

https://docs.npmjs.com/generating-provenance-statements

`npmTokenSecret`^Optional

Deprecated: Use NpmPublishOptions instead.

public readonly npmTokenSecret: string;

Type: string
Default: "NPM_TOKEN" or "GITHUB_TOKEN" if registry is set to npm.pkg.github.com.

GitHub secret which contains the NPM token to use for publishing packages.

`registry`^Optional

Deprecated: Use NpmPublishOptions instead.

public readonly registry: string;

Type: string
Default: "registry.npmjs.org"

The domain name of the npm package registry.

To publish to GitHub Packages, set this value to "npm.pkg.github.com". In this if npmTokenSecret is not specified, it will default to GITHUB_TOKEN which means that you will be able to publish to the repository's package store. In this case, make sure repositoryUrl is correctly defined.

Example

"npm.pkg.github.com"

`trustedPublishing`^Optional

Deprecated: Use NpmPublishOptions instead.

public readonly trustedPublishing: boolean;

Type: boolean
Default: false

Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.

Requires npm CLI version 11.5.1 or later, this is NOT ensured automatically. When used, npmTokenSecret will be ignored.

https://docs.npmjs.com/trusted-publishers

JsiiReleaseNuget

Initializer

import { release } from 'projen'

const jsiiReleaseNuget: release.JsiiReleaseNuget = { ... }

Properties

Name	Type	Description
`githubEnvironment`	`string`	The GitHub Actions environment used for publishing.
`postPublishSteps`	`projen.github.workflows.JobStep[]`	Steps to execute after executing the publishing command.
`prePublishSteps`	`projen.github.workflows.JobStep[]`	Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if needed.
`publishTools`	`projen.github.workflows.Tools`	Additional tools to install in the publishing job.
`nugetApiKeySecret`	`string`	GitHub secret which contains the API key for NuGet.
`nugetServer`	`string`	NuGet Server URL (defaults to nuget.org).
`nugetUsernameSecret`	`string`	The NuGet.org username (profile name, not email address) for trusted publisher authentication.
`trustedPublishing`	`boolean`	Use NuGet trusted publishing instead of API keys.

`githubEnvironment`^Optional

Deprecated: Use NugetPublishOptions instead.

public readonly githubEnvironment: string;

Type: string
Default: no environment used, unless set at the package level

The GitHub Actions environment used for publishing.

This can be used to add an explicit approval step to the release or limit who can initiate a release through environment protection rules.

Set this to overwrite a package level publishing environment just for this artifact.

`postPublishSteps`^Optional

Deprecated: Use NugetPublishOptions instead.

public readonly postPublishSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

Steps to execute after executing the publishing command.

These can be used to add/update the release artifacts ot any other tasks needed.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPostPublishingSteps.

`prePublishSteps`^Optional

Deprecated: Use NugetPublishOptions instead.

public readonly prePublishSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if needed.

These steps are executed after dist/ has been populated with the build output.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPrePublishingSteps.

`publishTools`^Optional

Deprecated: Use NugetPublishOptions instead.

public readonly publishTools: Tools;

Type: projen.github.workflows.Tools
Default: no additional tools are installed

Additional tools to install in the publishing job.

`nugetApiKeySecret`^Optional

Deprecated: Use NugetPublishOptions instead.

public readonly nugetApiKeySecret: string;

Type: string
Default: "NUGET_API_KEY"

GitHub secret which contains the API key for NuGet.

`nugetServer`^Optional

Deprecated: Use NugetPublishOptions instead.

public readonly nugetServer: string;

Type: string

NuGet Server URL (defaults to nuget.org).

`nugetUsernameSecret`^Optional

Deprecated: Use NugetPublishOptions instead.

public readonly nugetUsernameSecret: string;

Type: string
Default: "NUGET_USERNAME"

The NuGet.org username (profile name, not email address) for trusted publisher authentication.

Required when using trusted publishing.

`trustedPublishing`^Optional

Deprecated: Use NugetPublishOptions instead.

public readonly trustedPublishing: boolean;

Type: boolean

Use NuGet trusted publishing instead of API keys.

Needs to be setup in NuGet.org.

https://learn.microsoft.com/en-us/nuget/nuget-org/trusted-publishing

JsiiReleasePyPi

Initializer

import { release } from 'projen'

const jsiiReleasePyPi: release.JsiiReleasePyPi = { ... }

Properties

Name	Type	Description
`githubEnvironment`	`string`	The GitHub Actions environment used for publishing.
`postPublishSteps`	`projen.github.workflows.JobStep[]`	Steps to execute after executing the publishing command.
`prePublishSteps`	`projen.github.workflows.JobStep[]`	Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if needed.
`publishTools`	`projen.github.workflows.Tools`	Additional tools to install in the publishing job.
`attestations`	`boolean`	Generate and publish cryptographic attestations for files uploaded to PyPI.
`codeArtifactOptions`	`CodeArtifactOptions`	Options for publishing to AWS CodeArtifact.
`trustedPublishing`	`boolean`	Use PyPI trusted publishing instead of tokens or username & password.
`twinePasswordSecret`	`string`	The GitHub secret which contains PyPI password.
`twineRegistryUrl`	`string`	The registry url to use when releasing packages.
`twineUsernameSecret`	`string`	The GitHub secret which contains PyPI user name.

`githubEnvironment`^Optional

Deprecated: Use PyPiPublishOptions instead.

public readonly githubEnvironment: string;

Type: string
Default: no environment used, unless set at the package level

The GitHub Actions environment used for publishing.

This can be used to add an explicit approval step to the release or limit who can initiate a release through environment protection rules.

Set this to overwrite a package level publishing environment just for this artifact.

`postPublishSteps`^Optional

Deprecated: Use PyPiPublishOptions instead.

public readonly postPublishSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

Steps to execute after executing the publishing command.

These can be used to add/update the release artifacts ot any other tasks needed.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPostPublishingSteps.

`prePublishSteps`^Optional

Deprecated: Use PyPiPublishOptions instead.

public readonly prePublishSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if needed.

These steps are executed after dist/ has been populated with the build output.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPrePublishingSteps.

`publishTools`^Optional

Deprecated: Use PyPiPublishOptions instead.

public readonly publishTools: Tools;

Type: projen.github.workflows.Tools
Default: no additional tools are installed

Additional tools to install in the publishing job.

`attestations`^Optional

Deprecated: Use PyPiPublishOptions instead.

public readonly attestations: boolean;

Type: boolean
Default: enabled when using trusted publishing, otherwise not applicable

Generate and publish cryptographic attestations for files uploaded to PyPI.

Attestations provide package provenance and integrity an can be viewed on PyPI. They are only available when using a Trusted Publisher for publishing.

https://docs.pypi.org/attestations/producing-attestations/

`codeArtifactOptions`^Optional

Deprecated: Use PyPiPublishOptions instead.

public readonly codeArtifactOptions: CodeArtifactOptions;

Type: CodeArtifactOptions
Default: undefined

Options for publishing to AWS CodeArtifact.

`trustedPublishing`^Optional

Deprecated: Use PyPiPublishOptions instead.

public readonly trustedPublishing: boolean;

Type: boolean

Use PyPI trusted publishing instead of tokens or username & password.

Needs to be setup in PyPI.

https://docs.pypi.org/trusted-publishers/adding-a-publisher/

`twinePasswordSecret`^Optional

Deprecated: Use PyPiPublishOptions instead.

public readonly twinePasswordSecret: string;

Type: string
Default: "TWINE_PASSWORD"

The GitHub secret which contains PyPI password.

`twineRegistryUrl`^Optional

Deprecated: Use PyPiPublishOptions instead.

public readonly twineRegistryUrl: string;

Type: string
Default: twine default

The registry url to use when releasing packages.

`twineUsernameSecret`^Optional

Deprecated: Use PyPiPublishOptions instead.

public readonly twineUsernameSecret: string;

Type: string
Default: "TWINE_USERNAME"

The GitHub secret which contains PyPI user name.

ManualReleaseOptions

Initializer

import { release } from 'projen'

const manualReleaseOptions: release.ManualReleaseOptions = { ... }

Properties

Name	Type	Description
`changelog`	`boolean`	Maintain a project-level changelog.
`changelogPath`	`string`	Project-level changelog file path.
`gitPushCommand`	`string`	Override git-push command.

`changelog`^Optional

public readonly changelog: boolean;

Type: boolean
Default: true

Maintain a project-level changelog.

`changelogPath`^Optional

public readonly changelogPath: string;

Type: string
Default: 'CHANGELOG.md'

Project-level changelog file path.

Ignored if changelog is false.

`gitPushCommand`^Optional

public readonly gitPushCommand: string;

Type: string

Override git-push command.

Set to an empty string to disable pushing.

MavenPublishOptions

Options for Maven releases.

Initializer

import { release } from 'projen'

const mavenPublishOptions: release.MavenPublishOptions = { ... }

Properties

Name	Type	Description
`githubEnvironment`	`string`	The GitHub Actions environment used for publishing.
`postPublishSteps`	`projen.github.workflows.JobStep[]`	Steps to execute after executing the publishing command.
`prePublishSteps`	`projen.github.workflows.JobStep[]`	Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if needed.
`publishTools`	`projen.github.workflows.Tools`	Additional tools to install in the publishing job.
`mavenEndpoint`	`string`	URL of Nexus repository.
`mavenGpgPrivateKeyPassphrase`	`string`	GitHub secret name which contains the GPG private key or file that includes it.
`mavenGpgPrivateKeySecret`	`string`	GitHub secret name which contains the GPG private key or file that includes it.
`mavenPassword`	`string`	GitHub secret name which contains the Password for maven repository.
`mavenRepositoryUrl`	`string`	Deployment repository when not deploying to Maven Central.
`mavenServerId`	`string`	Used in maven settings for credential lookup (e.g. use github when publishing to GitHub).
`mavenStagingProfileId`	`string`	GitHub secret name which contains the Maven Central (sonatype) staging profile ID (e.g. 68a05363083174). Staging profile ID can be found in the URL of the "Releases" staging profile under "Staging Profiles" in https://oss.sonatype.org (e.g. https://oss.sonatype.org/#stagingProfiles;11a33451234521).
`mavenUsername`	`string`	GitHub secret name which contains the Username for maven repository.

`githubEnvironment`^Optional

public readonly githubEnvironment: string;

Type: string
Default: no environment used, unless set at the package level

The GitHub Actions environment used for publishing.

This can be used to add an explicit approval step to the release or limit who can initiate a release through environment protection rules.

Set this to overwrite a package level publishing environment just for this artifact.

`postPublishSteps`^Optional

public readonly postPublishSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

Steps to execute after executing the publishing command.

These can be used to add/update the release artifacts ot any other tasks needed.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPostPublishingSteps.

`prePublishSteps`^Optional

public readonly prePublishSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if needed.

These steps are executed after dist/ has been populated with the build output.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPrePublishingSteps.

`publishTools`^Optional

public readonly publishTools: Tools;

Type: projen.github.workflows.Tools
Default: no additional tools are installed

Additional tools to install in the publishing job.

`mavenEndpoint`^Optional

public readonly mavenEndpoint: string;

Type: string
Default: "https://oss.sonatype.org" or none when publishing to Maven Central

URL of Nexus repository.

if not set, defaults to https://oss.sonatype.org

`mavenGpgPrivateKeyPassphrase`^Optional

public readonly mavenGpgPrivateKeyPassphrase: string;

Type: string
Default: "MAVEN_GPG_PRIVATE_KEY_PASSPHRASE" or not set when using GitHub Packages

GitHub secret name which contains the GPG private key or file that includes it.

This is used to sign your Maven packages. See instructions.

https://github.com/aws/publib#maven

`mavenGpgPrivateKeySecret`^Optional

public readonly mavenGpgPrivateKeySecret: string;

Type: string
Default: "MAVEN_GPG_PRIVATE_KEY" or not set when using GitHub Packages

GitHub secret name which contains the GPG private key or file that includes it.

This is used to sign your Maven packages. See instructions.

https://github.com/aws/publib#maven

`mavenPassword`^Optional

public readonly mavenPassword: string;

Type: string
Default: "MAVEN_PASSWORD" or "GITHUB_TOKEN" when using GitHub Packages

GitHub secret name which contains the Password for maven repository.

For Maven Central, you will need to Create JIRA account and then request a new project (see links).

https://issues.sonatype.org/secure/CreateIssue.jspa?issuetype=21&pid=10134

`mavenRepositoryUrl`^Optional

public readonly mavenRepositoryUrl: string;

Type: string
Default: not set

Deployment repository when not deploying to Maven Central.

`mavenServerId`^Optional

public readonly mavenServerId: string;

Type: string
Default: "ossrh" (Maven Central) or "github" when using GitHub Packages

Used in maven settings for credential lookup (e.g. use github when publishing to GitHub).

Set to central-ossrh to publish to Maven Central.

`mavenStagingProfileId`^Optional

public readonly mavenStagingProfileId: string;

Type: string
Default: "MAVEN_STAGING_PROFILE_ID" or not set when using GitHub Packages

`mavenUsername`^Optional

public readonly mavenUsername: string;

Type: string
Default: "MAVEN_USERNAME" or the GitHub Actor when using GitHub Packages

GitHub secret name which contains the Username for maven repository.

For Maven Central, you will need to Create JIRA account and then request a new project (see links).

https://issues.sonatype.org/secure/CreateIssue.jspa?issuetype=21&pid=10134

NpmPublishOptions

Options for npm release.

Initializer

import { release } from 'projen'

const npmPublishOptions: release.NpmPublishOptions = { ... }

Properties

Name	Type	Description
`githubEnvironment`	`string`	The GitHub Actions environment used for publishing.
`postPublishSteps`	`projen.github.workflows.JobStep[]`	Steps to execute after executing the publishing command.
`prePublishSteps`	`projen.github.workflows.JobStep[]`	Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if needed.
`publishTools`	`projen.github.workflows.Tools`	Additional tools to install in the publishing job.
`codeArtifactOptions`	`CodeArtifactOptions`	Options for publishing npm package to AWS CodeArtifact.
`distTag`	`string`	Tags can be used to provide an alias instead of version numbers.
`npmProvenance`	`boolean`	Should provenance statements be generated when package is published.
`npmTokenSecret`	`string`	GitHub secret which contains the NPM token to use for publishing packages.
`registry`	`string`	The domain name of the npm package registry.
`trustedPublishing`	`boolean`	Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.

`githubEnvironment`^Optional

public readonly githubEnvironment: string;

Type: string
Default: no environment used, unless set at the package level

The GitHub Actions environment used for publishing.

This can be used to add an explicit approval step to the release or limit who can initiate a release through environment protection rules.

Set this to overwrite a package level publishing environment just for this artifact.

`postPublishSteps`^Optional

public readonly postPublishSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

Steps to execute after executing the publishing command.

These can be used to add/update the release artifacts ot any other tasks needed.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPostPublishingSteps.

`prePublishSteps`^Optional

public readonly prePublishSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if needed.

These steps are executed after dist/ has been populated with the build output.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPrePublishingSteps.

`publishTools`^Optional

public readonly publishTools: Tools;

Type: projen.github.workflows.Tools
Default: no additional tools are installed

Additional tools to install in the publishing job.

`codeArtifactOptions`^Optional

public readonly codeArtifactOptions: CodeArtifactOptions;

Type: CodeArtifactOptions
Default: package is not published to

Options for publishing npm package to AWS CodeArtifact.

`distTag`^Optional

Deprecated: Use npmDistTag for each release branch instead.

public readonly distTag: string;

Type: string
Default: "latest"

Tags can be used to provide an alias instead of version numbers.

For example, a project might choose to have multiple streams of development and use a different tag for each stream, e.g., stable, beta, dev, canary.

The next tag is used by some projects to identify the upcoming version.

`npmProvenance`^Optional

public readonly npmProvenance: boolean;

Type: boolean
Default: enabled for for public packages using trusted publishing, disabled otherwise

Should provenance statements be generated when package is published.

Note that this component is using publib to publish packages, which is using npm internally and supports provenance statements independently of the package manager used.

Only works in supported CI/CD environments.

https://docs.npmjs.com/generating-provenance-statements

`npmTokenSecret`^Optional

public readonly npmTokenSecret: string;

Type: string
Default: "NPM_TOKEN" or "GITHUB_TOKEN" if registry is set to npm.pkg.github.com.

GitHub secret which contains the NPM token to use for publishing packages.

`registry`^Optional

public readonly registry: string;

Type: string
Default: "registry.npmjs.org"

The domain name of the npm package registry.

Example

"npm.pkg.github.com"

`trustedPublishing`^Optional

public readonly trustedPublishing: boolean;

Type: boolean
Default: false

Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.

Requires npm CLI version 11.5.1 or later, this is NOT ensured automatically. When used, npmTokenSecret will be ignored.

https://docs.npmjs.com/trusted-publishers

NugetPublishOptions

Options for NuGet releases.

Initializer

import { release } from 'projen'

const nugetPublishOptions: release.NugetPublishOptions = { ... }

Properties

Name	Type	Description
`githubEnvironment`	`string`	The GitHub Actions environment used for publishing.
`postPublishSteps`	`projen.github.workflows.JobStep[]`	Steps to execute after executing the publishing command.
`prePublishSteps`	`projen.github.workflows.JobStep[]`	Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if needed.
`publishTools`	`projen.github.workflows.Tools`	Additional tools to install in the publishing job.
`nugetApiKeySecret`	`string`	GitHub secret which contains the API key for NuGet.
`nugetServer`	`string`	NuGet Server URL (defaults to nuget.org).
`nugetUsernameSecret`	`string`	The NuGet.org username (profile name, not email address) for trusted publisher authentication.
`trustedPublishing`	`boolean`	Use NuGet trusted publishing instead of API keys.

`githubEnvironment`^Optional

public readonly githubEnvironment: string;

Type: string
Default: no environment used, unless set at the package level

The GitHub Actions environment used for publishing.

This can be used to add an explicit approval step to the release or limit who can initiate a release through environment protection rules.

Set this to overwrite a package level publishing environment just for this artifact.

`postPublishSteps`^Optional

public readonly postPublishSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

Steps to execute after executing the publishing command.

These can be used to add/update the release artifacts ot any other tasks needed.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPostPublishingSteps.

`prePublishSteps`^Optional

public readonly prePublishSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if needed.

These steps are executed after dist/ has been populated with the build output.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPrePublishingSteps.

`publishTools`^Optional

public readonly publishTools: Tools;

Type: projen.github.workflows.Tools
Default: no additional tools are installed

Additional tools to install in the publishing job.

`nugetApiKeySecret`^Optional

public readonly nugetApiKeySecret: string;

Type: string
Default: "NUGET_API_KEY"

GitHub secret which contains the API key for NuGet.

`nugetServer`^Optional

public readonly nugetServer: string;

Type: string

NuGet Server URL (defaults to nuget.org).

`nugetUsernameSecret`^Optional

public readonly nugetUsernameSecret: string;

Type: string
Default: "NUGET_USERNAME"

The NuGet.org username (profile name, not email address) for trusted publisher authentication.

Required when using trusted publishing.

`trustedPublishing`^Optional

public readonly trustedPublishing: boolean;

Type: boolean

Use NuGet trusted publishing instead of API keys.

Needs to be setup in NuGet.org.

https://learn.microsoft.com/en-us/nuget/nuget-org/trusted-publishing

PublisherOptions

Options for Publisher.

Initializer

import { release } from 'projen'

const publisherOptions: release.PublisherOptions = { ... }

Properties

Name	Type	Description
`artifactName`	`string`	The name of the artifact to download (e.g. `dist`).
`buildJobId`	`string`	The job ID that produces the build artifacts.
`condition`	`string`	A GitHub workflow expression used as a condition for publishers.
`dryRun`	`boolean`	Do not actually publish, only print the commands that would be executed instead.
`failureIssue`	`boolean`	Create an issue when a publish task fails.
`failureIssueLabel`	`string`	The label to apply to the issue marking failed publish tasks.
`jsiiReleaseVersion`	`string`	No description.
`publibVersion`	`string`	Version requirement for `publib`.
`publishTasks`	`boolean`	Define publishing tasks that can be executed manually as well as workflows.
`workflowContainerImage`	`string`	Container image to use for GitHub workflows.
`workflowNodeVersion`	`string`	Node version to setup in GitHub workflows if any node-based CLI utilities are needed.
`workflowRunsOn`	`string[]`	Github Runner selection labels.
`workflowRunsOnGroup`	`projen.GroupRunnerOptions`	Github Runner Group selection options.

`artifactName`^Required

public readonly artifactName: string;

Type: string

The name of the artifact to download (e.g. dist).

The artifact is expected to include a subdirectory for each release target: go (GitHub), dotnet (NuGet), java (Maven), js (npm), python (PyPI).

https://github.com/aws/publib

`buildJobId`^Required

public readonly buildJobId: string;

Type: string

The job ID that produces the build artifacts.

All publish jobs will take a dependency on this job.

`condition`^Optional

public readonly condition: string;

Type: string
Default: no condition

A GitHub workflow expression used as a condition for publishers.

`dryRun`^Optional

public readonly dryRun: boolean;

Type: boolean

Do not actually publish, only print the commands that would be executed instead.

Useful if you wish to block all publishing from a single option.

`failureIssue`^Optional

public readonly failureIssue: boolean;

Type: boolean
Default: false

Create an issue when a publish task fails.

`failureIssueLabel`^Optional

public readonly failureIssueLabel: string;

Type: string
Default: "failed-release"

The label to apply to the issue marking failed publish tasks.

Only applies if failureIssue is true.

`jsiiReleaseVersion`^Optional

Deprecated: use publibVersion instead

public readonly jsiiReleaseVersion: string;

Type: string

`publibVersion`^Optional

public readonly publibVersion: string;

Type: string
Default: "latest"

Version requirement for publib.

`publishTasks`^Optional

public readonly publishTasks: boolean;

Type: boolean
Default: false

Define publishing tasks that can be executed manually as well as workflows.

Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity.

`workflowContainerImage`^Optional

public readonly workflowContainerImage: string;

Type: string
Default: default image

Container image to use for GitHub workflows.

`workflowNodeVersion`^Optional

public readonly workflowNodeVersion: string;

Type: string
Default: lts/*

Node version to setup in GitHub workflows if any node-based CLI utilities are needed.

For example publib, the CLI projen uses to publish releases, is an npm library.

`workflowRunsOn`^Optional

public readonly workflowRunsOn: string[];

Type: string[]
Default: ["ubuntu-latest"]

Github Runner selection labels.

`workflowRunsOnGroup`^Optional

public readonly workflowRunsOnGroup: GroupRunnerOptions;

Type: projen.GroupRunnerOptions

Github Runner Group selection options.

PyPiPublishOptions

Options for PyPI release.

Initializer

import { release } from 'projen'

const pyPiPublishOptions: release.PyPiPublishOptions = { ... }

Properties

Name	Type	Description
`githubEnvironment`	`string`	The GitHub Actions environment used for publishing.
`postPublishSteps`	`projen.github.workflows.JobStep[]`	Steps to execute after executing the publishing command.
`prePublishSteps`	`projen.github.workflows.JobStep[]`	Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if needed.
`publishTools`	`projen.github.workflows.Tools`	Additional tools to install in the publishing job.
`attestations`	`boolean`	Generate and publish cryptographic attestations for files uploaded to PyPI.
`codeArtifactOptions`	`CodeArtifactOptions`	Options for publishing to AWS CodeArtifact.
`trustedPublishing`	`boolean`	Use PyPI trusted publishing instead of tokens or username & password.
`twinePasswordSecret`	`string`	The GitHub secret which contains PyPI password.
`twineRegistryUrl`	`string`	The registry url to use when releasing packages.
`twineUsernameSecret`	`string`	The GitHub secret which contains PyPI user name.

`githubEnvironment`^Optional

public readonly githubEnvironment: string;

Type: string
Default: no environment used, unless set at the package level

The GitHub Actions environment used for publishing.

This can be used to add an explicit approval step to the release or limit who can initiate a release through environment protection rules.

Set this to overwrite a package level publishing environment just for this artifact.

`postPublishSteps`^Optional

public readonly postPublishSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

Steps to execute after executing the publishing command.

These can be used to add/update the release artifacts ot any other tasks needed.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPostPublishingSteps.

`prePublishSteps`^Optional

public readonly prePublishSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if needed.

These steps are executed after dist/ has been populated with the build output.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPrePublishingSteps.

`publishTools`^Optional

public readonly publishTools: Tools;

Type: projen.github.workflows.Tools
Default: no additional tools are installed

Additional tools to install in the publishing job.

`attestations`^Optional

public readonly attestations: boolean;

Type: boolean
Default: enabled when using trusted publishing, otherwise not applicable

Generate and publish cryptographic attestations for files uploaded to PyPI.

Attestations provide package provenance and integrity an can be viewed on PyPI. They are only available when using a Trusted Publisher for publishing.

https://docs.pypi.org/attestations/producing-attestations/

`codeArtifactOptions`^Optional

public readonly codeArtifactOptions: CodeArtifactOptions;

Type: CodeArtifactOptions
Default: undefined

Options for publishing to AWS CodeArtifact.

`trustedPublishing`^Optional

public readonly trustedPublishing: boolean;

Type: boolean

Use PyPI trusted publishing instead of tokens or username & password.

Needs to be setup in PyPI.

https://docs.pypi.org/trusted-publishers/adding-a-publisher/

`twinePasswordSecret`^Optional

public readonly twinePasswordSecret: string;

Type: string
Default: "TWINE_PASSWORD"

The GitHub secret which contains PyPI password.

`twineRegistryUrl`^Optional

public readonly twineRegistryUrl: string;

Type: string
Default: twine default

The registry url to use when releasing packages.

`twineUsernameSecret`^Optional

public readonly twineUsernameSecret: string;

Type: string
Default: "TWINE_USERNAME"

The GitHub secret which contains PyPI user name.

ReleaseOptions

Options for Release.

Initializer

import { release } from 'projen'

const releaseOptions: release.ReleaseOptions = { ... }

Properties

Name	Type	Description
`bumpPackage`	`string`	The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string.
`jsiiReleaseVersion`	`string`	Version requirement of `publib` which is used to publish modules to npm.
`majorVersion`	`number`	Major version to release from the default branch.
`minMajorVersion`	`number`	Minimal Major version to release.
`nextVersionCommand`	`string`	A shell command to control the next version to release.
`npmDistTag`	`string`	The npmDistTag to use when publishing from the default branch.
`postBuildSteps`	`projen.github.workflows.JobStep[]`	Steps to execute after build as part of the release workflow.
`prerelease`	`string`	Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
`publishDryRun`	`boolean`	Instead of actually publishing to package managers, just print the publishing command.
`publishTasks`	`boolean`	Define publishing tasks that can be executed manually as well as workflows.
`releasableCommits`	`projen.ReleasableCommits`	Find commits that should be considered releasable Used to decide if a release is required.
`releaseBranches`	`{[ key: string ]: BranchOptions}`	Defines additional release branches.
`releaseEnvironment`	`string`	The GitHub Actions environment used for the release.
`releaseEveryCommit`	`boolean`	Automatically release new versions every commit to one of branches in `releaseBranches`.
`releaseFailureIssue`	`boolean`	Create a github issue on every failed publishing task.
`releaseFailureIssueLabel`	`string`	The label to apply to issues indicating publish failures.
`releaseSchedule`	`string`	CRON schedule to trigger new releases.
`releaseTagPrefix`	`string`	Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
`releaseTrigger`	`ReleaseTrigger`	The release trigger to use.
`releaseWorkflowEnv`	`{[ key: string ]: string}`	Build environment variables for release workflows.
`releaseWorkflowName`	`string`	The name of the default release workflow.
`releaseWorkflowSetupSteps`	`projen.github.workflows.JobStep[]`	A set of workflow steps to execute in order to setup the workflow container.
`versionrcOptions`	`{[ key: string ]: any}`	Custom configuration used when creating changelog with commit-and-tag-version package.
`workflowContainerImage`	`string`	Container image to use for GitHub workflows.
`workflowRunsOn`	`string[]`	Github Runner selection labels.
`workflowRunsOnGroup`	`projen.GroupRunnerOptions`	Github Runner Group selection options.
`artifactsDirectory`	`string`	A directory which will contain build artifacts.
`branch`	`string`	The default branch name to release from.
`task`	`projen.Task`	The task to execute in order to create the release artifacts.
`versionFile`	`string`	A name of a .json file to set the `version` field in after a bump.
`githubRelease`	`boolean`	Create a GitHub release for each release.
`workflowNodeVersion`	`string`	Node version to setup in GitHub workflows if any node-based CLI utilities are needed.
`workflowPermissions`	`projen.github.workflows.JobPermissions`	Permissions granted to the release workflow job.

`bumpPackage`^Optional

public readonly bumpPackage: string;

Type: string
Default: A recent version of "commit-and-tag-version"

The commit-and-tag-version compatible package used to bump the package version, as a dependency string.

This can be any compatible package version, including the deprecated standard-version@9.

`jsiiReleaseVersion`^Optional

public readonly jsiiReleaseVersion: string;

Type: string
Default: "latest"

Version requirement of publib which is used to publish modules to npm.

`majorVersion`^Optional

public readonly majorVersion: number;

Type: number
Default: Major version is not enforced.

Major version to release from the default branch.

If this is specified, we bump the latest version of this major version line. If not specified, we bump the global latest version.

`minMajorVersion`^Optional

public readonly minMajorVersion: number;

Type: number
Default: No minimum version is being enforced

Minimal Major version to release.

This can be useful to set to 1, as breaking changes before the 1.x major release are not incrementing the major version number.

Can not be set together with majorVersion.

`nextVersionCommand`^Optional

public readonly nextVersionCommand: string;

Type: string
Default: The next version will be determined based on the commit history and project settings.

A shell command to control the next version to release.

If present, this shell command will be run before the bump is executed, and it determines what version to release. It will be executed in the following environment:

Working directory: the project directory.
$VERSION: the current version. Looks like 1.2.3.
$LATEST_TAG: the most recent tag. Looks like prefix-v1.2.3, or may be unset.
$SUGGESTED_BUMP: the suggested bump action based on commits. One of major|minor|patch|none.

The command should print one of the following to stdout:

Nothing: the next version number will be determined based on commit history.
x.y.z: the next version number will be x.y.z.
major|minor|patch: the next version number will be the current version number with the indicated component bumped.

This setting cannot be specified together with minMajorVersion; the invoked script can be used to achieve the effects of minMajorVersion.

`npmDistTag`^Optional

public readonly npmDistTag: string;

Type: string
Default: "latest"

The npmDistTag to use when publishing from the default branch.

To set the npm dist-tag for release branches, set the npmDistTag property for each branch.

`postBuildSteps`^Optional

public readonly postBuildSteps: JobStep[];

Type: projen.github.workflows.JobStep[]
Default: []

Steps to execute after build as part of the release workflow.

`prerelease`^Optional

public readonly prerelease: string;

Type: string
Default: normal semantic versions

Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").

`publishDryRun`^Optional

public readonly publishDryRun: boolean;

Type: boolean
Default: false

Instead of actually publishing to package managers, just print the publishing command.

`publishTasks`^Optional

public readonly publishTasks: boolean;

Type: boolean
Default: false

Define publishing tasks that can be executed manually as well as workflows.

Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity.

`releasableCommits`^Optional

public readonly releasableCommits: ReleasableCommits;

Type: projen.ReleasableCommits
Default: ReleasableCommits.everyCommit()

Find commits that should be considered releasable Used to decide if a release is required.

`releaseBranches`^Optional

public readonly releaseBranches: {[ key: string ]: BranchOptions};

Type: {[ key: string ]: BranchOptions}
Default: no additional branches are used for release. you can use addBranch() to add additional branches.

Defines additional release branches.

A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch must be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the majorVersion field must also be provided for the default branch.

`releaseEnvironment`^Optional

public readonly releaseEnvironment: string;

Type: string
Default: no environment used, unless set at the artifact level

The GitHub Actions environment used for the release.

This can be used to add an explicit approval step to the release or limit who can initiate a release through environment protection rules.

When multiple artifacts are released, the environment can be overwritten on a per artifact basis.

`releaseEveryCommit`^Optional

Deprecated: Use releaseTrigger: ReleaseTrigger.continuous() instead

public readonly releaseEveryCommit: boolean;

Type: boolean
Default: true

Automatically release new versions every commit to one of branches in releaseBranches.

`releaseFailureIssue`^Optional

public readonly releaseFailureIssue: boolean;

Type: boolean
Default: false

Create a github issue on every failed publishing task.

`releaseFailureIssueLabel`^Optional

public readonly releaseFailureIssueLabel: string;

Type: string
Default: "failed-release"

The label to apply to issues indicating publish failures.

Only applies if releaseFailureIssue is true.

`releaseSchedule`^Optional

Deprecated: Use releaseTrigger: ReleaseTrigger.scheduled() instead

public readonly releaseSchedule: string;

Type: string
Default: no scheduled releases

CRON schedule to trigger new releases.

`releaseTagPrefix`^Optional

public readonly releaseTagPrefix: string;

Type: string
Default: "v"

Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.

`releaseTrigger`^Optional

public readonly releaseTrigger: ReleaseTrigger;

Type: ReleaseTrigger
Default: Continuous releases (ReleaseTrigger.continuous())

The release trigger to use.

`releaseWorkflowEnv`^Optional

public readonly releaseWorkflowEnv: {[ key: string ]: string};

Type: {[ key: string ]: string}
Default: {}

Build environment variables for release workflows.

`releaseWorkflowName`^Optional

public readonly releaseWorkflowName: string;

Type: string
Default: "release"

The name of the default release workflow.

`releaseWorkflowSetupSteps`^Optional

public readonly releaseWorkflowSetupSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

A set of workflow steps to execute in order to setup the workflow container.

`versionrcOptions`^Optional

public readonly versionrcOptions: {[ key: string ]: any};

Type: {[ key: string ]: any}
Default: standard configuration applicable for GitHub repositories

Custom configuration used when creating changelog with commit-and-tag-version package.

Given values either append to default configuration or overwrite values in it.

`workflowContainerImage`^Optional

public readonly workflowContainerImage: string;

Type: string
Default: default image

Container image to use for GitHub workflows.

`workflowRunsOn`^Optional

public readonly workflowRunsOn: string[];

Type: string[]
Default: ["ubuntu-latest"]

Github Runner selection labels.

`workflowRunsOnGroup`^Optional

public readonly workflowRunsOnGroup: GroupRunnerOptions;

Type: projen.GroupRunnerOptions

Github Runner Group selection options.

`artifactsDirectory`^Required

public readonly artifactsDirectory: string;

Type: string
Default: "dist"

A directory which will contain build artifacts.

`branch`^Required

public readonly branch: string;

Type: string

The default branch name to release from.

Use majorVersion to restrict this branch to only publish releases with a specific major version.

You can add additional branches using addBranch().

`task`^Required

public readonly task: Task;

Type: projen.Task

The task to execute in order to create the release artifacts.

Artifacts are expected to reside under artifactsDirectory (defaults to dist/) once build is complete.

`versionFile`^Required

public readonly versionFile: string;

Type: string

A name of a .json file to set the version field in after a bump.

Example

"package.json"

`githubRelease`^Optional

public readonly githubRelease: boolean;

Type: boolean
Default: true

Create a GitHub release for each release.

`workflowNodeVersion`^Optional

public readonly workflowNodeVersion: string;

Type: string
Default: "lts/*""

Node version to setup in GitHub workflows if any node-based CLI utilities are needed.

For example publib, the CLI projen uses to publish releases, is an npm library.

`workflowPermissions`^Optional

public readonly workflowPermissions: JobPermissions;

Type: projen.github.workflows.JobPermissions
Default: { contents: JobPermission.WRITE }

Permissions granted to the release workflow job.

ReleaseProjectOptions

Project options for release.

Initializer

import { release } from 'projen'

const releaseProjectOptions: release.ReleaseProjectOptions = { ... }

Properties

Name	Type	Description
`bumpPackage`	`string`	The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string.
`jsiiReleaseVersion`	`string`	Version requirement of `publib` which is used to publish modules to npm.
`majorVersion`	`number`	Major version to release from the default branch.
`minMajorVersion`	`number`	Minimal Major version to release.
`nextVersionCommand`	`string`	A shell command to control the next version to release.
`npmDistTag`	`string`	The npmDistTag to use when publishing from the default branch.
`postBuildSteps`	`projen.github.workflows.JobStep[]`	Steps to execute after build as part of the release workflow.
`prerelease`	`string`	Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
`publishDryRun`	`boolean`	Instead of actually publishing to package managers, just print the publishing command.
`publishTasks`	`boolean`	Define publishing tasks that can be executed manually as well as workflows.
`releasableCommits`	`projen.ReleasableCommits`	Find commits that should be considered releasable Used to decide if a release is required.
`releaseBranches`	`{[ key: string ]: BranchOptions}`	Defines additional release branches.
`releaseEnvironment`	`string`	The GitHub Actions environment used for the release.
`releaseEveryCommit`	`boolean`	Automatically release new versions every commit to one of branches in `releaseBranches`.
`releaseFailureIssue`	`boolean`	Create a github issue on every failed publishing task.
`releaseFailureIssueLabel`	`string`	The label to apply to issues indicating publish failures.
`releaseSchedule`	`string`	CRON schedule to trigger new releases.
`releaseTagPrefix`	`string`	Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
`releaseTrigger`	`ReleaseTrigger`	The release trigger to use.
`releaseWorkflowEnv`	`{[ key: string ]: string}`	Build environment variables for release workflows.
`releaseWorkflowName`	`string`	The name of the default release workflow.
`releaseWorkflowSetupSteps`	`projen.github.workflows.JobStep[]`	A set of workflow steps to execute in order to setup the workflow container.
`versionrcOptions`	`{[ key: string ]: any}`	Custom configuration used when creating changelog with commit-and-tag-version package.
`workflowContainerImage`	`string`	Container image to use for GitHub workflows.
`workflowRunsOn`	`string[]`	Github Runner selection labels.
`workflowRunsOnGroup`	`projen.GroupRunnerOptions`	Github Runner Group selection options.

`bumpPackage`^Optional

public readonly bumpPackage: string;

Type: string
Default: A recent version of "commit-and-tag-version"

The commit-and-tag-version compatible package used to bump the package version, as a dependency string.

This can be any compatible package version, including the deprecated standard-version@9.

`jsiiReleaseVersion`^Optional

public readonly jsiiReleaseVersion: string;

Type: string
Default: "latest"

Version requirement of publib which is used to publish modules to npm.

`majorVersion`^Optional

public readonly majorVersion: number;

Type: number
Default: Major version is not enforced.

Major version to release from the default branch.

If this is specified, we bump the latest version of this major version line. If not specified, we bump the global latest version.

`minMajorVersion`^Optional

public readonly minMajorVersion: number;

Type: number
Default: No minimum version is being enforced

Minimal Major version to release.

This can be useful to set to 1, as breaking changes before the 1.x major release are not incrementing the major version number.

Can not be set together with majorVersion.

`nextVersionCommand`^Optional

public readonly nextVersionCommand: string;

Type: string
Default: The next version will be determined based on the commit history and project settings.

A shell command to control the next version to release.

If present, this shell command will be run before the bump is executed, and it determines what version to release. It will be executed in the following environment:

Working directory: the project directory.
$VERSION: the current version. Looks like 1.2.3.
$LATEST_TAG: the most recent tag. Looks like prefix-v1.2.3, or may be unset.
$SUGGESTED_BUMP: the suggested bump action based on commits. One of major|minor|patch|none.

The command should print one of the following to stdout:

Nothing: the next version number will be determined based on commit history.
x.y.z: the next version number will be x.y.z.
major|minor|patch: the next version number will be the current version number with the indicated component bumped.

This setting cannot be specified together with minMajorVersion; the invoked script can be used to achieve the effects of minMajorVersion.

`npmDistTag`^Optional

public readonly npmDistTag: string;

Type: string
Default: "latest"

The npmDistTag to use when publishing from the default branch.

To set the npm dist-tag for release branches, set the npmDistTag property for each branch.

`postBuildSteps`^Optional

public readonly postBuildSteps: JobStep[];

Type: projen.github.workflows.JobStep[]
Default: []

Steps to execute after build as part of the release workflow.

`prerelease`^Optional

public readonly prerelease: string;

Type: string
Default: normal semantic versions

Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").

`publishDryRun`^Optional

public readonly publishDryRun: boolean;

Type: boolean
Default: false

Instead of actually publishing to package managers, just print the publishing command.

`publishTasks`^Optional

public readonly publishTasks: boolean;

Type: boolean
Default: false

Define publishing tasks that can be executed manually as well as workflows.

Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity.

`releasableCommits`^Optional

public readonly releasableCommits: ReleasableCommits;

Type: projen.ReleasableCommits
Default: ReleasableCommits.everyCommit()

Find commits that should be considered releasable Used to decide if a release is required.

`releaseBranches`^Optional

public readonly releaseBranches: {[ key: string ]: BranchOptions};

Type: {[ key: string ]: BranchOptions}
Default: no additional branches are used for release. you can use addBranch() to add additional branches.

Defines additional release branches.

`releaseEnvironment`^Optional

public readonly releaseEnvironment: string;

Type: string
Default: no environment used, unless set at the artifact level

The GitHub Actions environment used for the release.

This can be used to add an explicit approval step to the release or limit who can initiate a release through environment protection rules.

When multiple artifacts are released, the environment can be overwritten on a per artifact basis.

`releaseEveryCommit`^Optional

Deprecated: Use releaseTrigger: ReleaseTrigger.continuous() instead

public readonly releaseEveryCommit: boolean;

Type: boolean
Default: true

Automatically release new versions every commit to one of branches in releaseBranches.

`releaseFailureIssue`^Optional

public readonly releaseFailureIssue: boolean;

Type: boolean
Default: false

Create a github issue on every failed publishing task.

`releaseFailureIssueLabel`^Optional

public readonly releaseFailureIssueLabel: string;

Type: string
Default: "failed-release"

The label to apply to issues indicating publish failures.

Only applies if releaseFailureIssue is true.

`releaseSchedule`^Optional

Deprecated: Use releaseTrigger: ReleaseTrigger.scheduled() instead

public readonly releaseSchedule: string;

Type: string
Default: no scheduled releases

CRON schedule to trigger new releases.

`releaseTagPrefix`^Optional

public readonly releaseTagPrefix: string;

Type: string
Default: "v"

Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.

`releaseTrigger`^Optional

public readonly releaseTrigger: ReleaseTrigger;

Type: ReleaseTrigger
Default: Continuous releases (ReleaseTrigger.continuous())

The release trigger to use.

`releaseWorkflowEnv`^Optional

public readonly releaseWorkflowEnv: {[ key: string ]: string};

Type: {[ key: string ]: string}
Default: {}

Build environment variables for release workflows.

`releaseWorkflowName`^Optional

public readonly releaseWorkflowName: string;

Type: string
Default: "release"

The name of the default release workflow.

`releaseWorkflowSetupSteps`^Optional

public readonly releaseWorkflowSetupSteps: JobStep[];

Type: projen.github.workflows.JobStep[]

A set of workflow steps to execute in order to setup the workflow container.

`versionrcOptions`^Optional

public readonly versionrcOptions: {[ key: string ]: any};

Type: {[ key: string ]: any}
Default: standard configuration applicable for GitHub repositories

Custom configuration used when creating changelog with commit-and-tag-version package.

Given values either append to default configuration or overwrite values in it.

`workflowContainerImage`^Optional

public readonly workflowContainerImage: string;

Type: string
Default: default image

Container image to use for GitHub workflows.

`workflowRunsOn`^Optional

public readonly workflowRunsOn: string[];

Type: string[]
Default: ["ubuntu-latest"]

Github Runner selection labels.

`workflowRunsOnGroup`^Optional

public readonly workflowRunsOnGroup: GroupRunnerOptions;

Type: projen.GroupRunnerOptions

Github Runner Group selection options.

ScheduledReleaseOptions

Initializer

import { release } from 'projen'

const scheduledReleaseOptions: release.ScheduledReleaseOptions = { ... }

Properties

Name	Type	Description
`schedule`	`string`	Cron schedule for releases.

`schedule`^Required

public readonly schedule: string;

Type: string

Cron schedule for releases.

Only defined if this is a scheduled release.

Example

'0 17 * * *' - every day at 5 pm

Classes

ReleaseTrigger

Used to manage release strategies.

This includes release and release artifact automation

Static Functions

Name	Description
`continuous`	Creates a continuous release trigger.
`manual`	Creates a manual release trigger.
`scheduled`	Creates a scheduled release trigger.
`workflowDispatch`	The release can only be triggered using the GitHub UI.

`continuous`

import { release } from 'projen'

release.ReleaseTrigger.continuous(options?: ContinuousReleaseOptions)

Creates a continuous release trigger.

Automated releases will occur on every commit.

`options`^Optional

Type: ContinuousReleaseOptions

`manual`

import { release } from 'projen'

release.ReleaseTrigger.manual(options?: ManualReleaseOptions)

Creates a manual release trigger.

Use this option if you want totally manual releases.

This will give you a release task that, in addition to the normal release activities will trigger a publish:git task. This task will handle project-level changelog management, release tagging, and pushing these artifacts to origin.

The command used for pushing can be customised by specifying gitPushCommand. Set to an empty string to disable pushing entirely.

Simply run yarn release to trigger a manual release.

`options`^Optional

Type: ManualReleaseOptions

release options.

`scheduled`

import { release } from 'projen'

release.ReleaseTrigger.scheduled(options: ScheduledReleaseOptions)

Creates a scheduled release trigger.

Automated releases will occur based on the provided cron schedule.

`options`^Required

Type: ScheduledReleaseOptions

release options.

`workflowDispatch`

import { release } from 'projen'

release.ReleaseTrigger.workflowDispatch()

The release can only be triggered using the GitHub UI.

Properties

Name	Type	Description
`isContinuous`	`boolean`	Whether or not this is a continuous release.
`isManual`	`boolean`	Whether or not this is a release trigger with a manual task run in a working copy.
`changelogPath`	`string`	Project-level changelog file path.
`gitPushCommand`	`string`	Override git-push command used when releasing manually.
`paths`	`string[]`	Paths for which pushes will trigger a release when `isContinuous` is `true`.
`schedule`	`string`	Cron schedule for releases.

`isContinuous`^Required

public readonly isContinuous: boolean;

Type: boolean

Whether or not this is a continuous release.

`isManual`^Required

public readonly isManual: boolean;

Type: boolean

Whether or not this is a release trigger with a manual task run in a working copy.

If the ReleaseTrigger is a GitHub-only manual task, this will return false.

`changelogPath`^Optional

public readonly changelogPath: string;

Type: string

Project-level changelog file path.

`gitPushCommand`^Optional

public readonly gitPushCommand: string;

Type: string

Override git-push command used when releasing manually.

Set to an empty string to disable pushing.

`paths`^Optional

public readonly paths: string[];

Type: string[]

Paths for which pushes will trigger a release when isContinuous is true.

`schedule`^Optional

public readonly schedule: string;

Type: string

Cron schedule for releases.

Only defined if this is a scheduled release.

Example

'0 17 * * *' - every day at 5 pm

Enums

CodeArtifactAuthProvider

Options for authorizing requests to a AWS CodeArtifact npm repository.

Members

Name	Description
`ACCESS_AND_SECRET_KEY_PAIR`	Fixed credentials provided via Github secrets.
`GITHUB_OIDC`	Ephemeral credentials provided via Github's OIDC integration with an IAM role.

`ACCESS_AND_SECRET_KEY_PAIR`

Fixed credentials provided via Github secrets.

`GITHUB_OIDC`

Ephemeral credentials provided via Github's OIDC integration with an IAM role.

See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services

release Submodule

Constructs ​

Publisher ​

Initializers ​

projectRequired ​

optionsRequired ​

Methods ​

toString ​

postSynthesize ​

preSynthesize ​

synthesize ​

addGitHubPostPublishingSteps ​

stepsRequired ​

addGitHubPrePublishingSteps ​

stepsRequired ​

publishToGit ​

optionsRequired ​

publishToGitHubReleases ​

optionsRequired ​

publishToGo ​

optionsOptional ​

publishToMaven ​

optionsOptional ​

publishToNpm ​

optionsOptional ​

publishToNuget ​

optionsOptional ​

publishToPyPi ​

optionsOptional ​

Static Functions ​

isConstruct ​

xRequired ​

isComponent ​

xRequired ​

Properties ​

nodeRequired ​

projectRequired ​

artifactNameRequired ​

buildJobIdRequired ​

jsiiReleaseVersionRequired ​

publibVersionRequired ​

conditionOptional ​

Constants ​

PUBLISH_GIT_TASK_NAMERequired ​

Release ​

Initializers ​

scopeRequired ​

optionsRequired ​

Methods ​

toString ​

postSynthesize ​

preSynthesize ​

synthesize ​

addBranch ​

branchRequired ​

optionsRequired ​

addJobs ​

jobsRequired ​

Static Functions ​

isConstruct ​

xRequired ​

isComponent ​

xRequired ​

of ​

projectRequired ​

Properties ​

nodeRequired ​

projectRequired ​

artifactsDirectoryRequired ​

branchesRequired ​

publisherRequired ​

Constants ​

ANTI_TAMPER_CMDRequired ​

Structs ​

BranchOptions ​

Initializer ​

Properties ​

majorVersionRequired ​

environmentOptional ​

minMajorVersionOptional ​

`release` Submodule

Constructs

Publisher

Initializers

`project`^Required

`options`^Required

Methods

`toString`

`postSynthesize`

`preSynthesize`

`synthesize`

`addGitHubPostPublishingSteps`

`steps`^Required

`addGitHubPrePublishingSteps`

`steps`^Required

`publishToGit`

`options`^Required

`publishToGitHubReleases`

`options`^Required

`publishToGo`

`options`^Optional

`publishToMaven`

`options`^Optional

`publishToNpm`

`options`^Optional

`publishToNuget`

`options`^Optional

`publishToPyPi`

`options`^Optional

Static Functions

`isConstruct`

`x`^Required

`isComponent`

`x`^Required

Properties

`node`^Required

`project`^Required

`artifactName`^Required

`buildJobId`^Required

`jsiiReleaseVersion`^Required

`publibVersion`^Required

`condition`^Optional

Constants

`PUBLISH_GIT_TASK_NAME`^Required

Release

Initializers

`scope`^Required

`options`^Required

Methods

`toString`

`postSynthesize`

`preSynthesize`

`synthesize`

`addBranch`

`branch`^Required

`options`^Required

`addJobs`

`jobs`^Required

Static Functions

`isConstruct`

`x`^Required

`isComponent`

`x`^Required

`of`

`project`^Required

Properties

`node`^Required

`project`^Required

`artifactsDirectory`^Required

`branches`^Required

`publisher`^Required

Constants

`ANTI_TAMPER_CMD`^Required

Structs

BranchOptions

Initializer

Properties

`majorVersion`^Required

`environment`^Optional

`minMajorVersion`^Optional