projen 0.52.23 → 0.52.24

package/lib/release/publisher.d.ts

@@ -3,109 +3,78 @@ import { Job, JobStep, Tools } from "../github/workflows-model";
 import { Project } from "../project";
 import { BranchOptions } from "./release";
 /**
- * (experimental) Options for `Publisher`.
- *
- * @experimental
+ * Options for `Publisher`.
  */
 export interface PublisherOptions {
     /**
-     * (experimental) The job ID that produces the build artifacts.
-     *
-     * All publish jobs will take a dependency on this job.
-     *
-     * @experimental
+     * The job ID that produces the build artifacts. All publish jobs will take a dependency on this job.
      */
     readonly buildJobId: string;
     /**
-     * (experimental) A GitHub workflow expression used as a condition for publishers.
+     * A GitHub workflow expression used as a condition for publishers.
      *
      * @default - no condition
-     * @experimental
      */
     readonly condition?: string;
     /**
-     * (experimental) The name of the artifact to download (e.g. `dist`).
+     * 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).
      *
      * @see https://github.com/aws/jsii-release
-     * @experimental
      */
     readonly artifactName: string;
     /**
-     * (experimental) Version requirement for `jsii-release`.
+     * Version requirement for `jsii-release`.
      *
      * @default "latest"
-     * @experimental
      */
     readonly jsiiReleaseVersion?: string;
     /**
-     * (experimental) Create an issue when a publish task fails.
+     * Create an issue when a publish task fails.
      *
      * @default false
-     * @experimental
      */
     readonly failureIssue?: boolean;
     /**
-     * (experimental) The label to apply to the issue marking failed publish tasks.
-     *
+     * The label to apply to the issue marking failed publish tasks.
      * Only applies if `failureIssue` is true.
      *
      * @default "failed-release"
-     * @experimental
      */
     readonly failureIssueLabel?: string;
     /**
-     * (experimental) Github Runner selection labels.
-     *
+     * Github Runner selection labels
      * @default ["ubuntu-latest"]
-     * @experimental
      */
     readonly workflowRunsOn?: string[];
     /**
-     * (experimental) Define publishing tasks that can be executed manually as well as workflows.
+     * 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.
      *
      * @default false
-     * @experimental
      */
     readonly publishTasks?: boolean;
     /**
-     * (experimental) Do not actually publish, only print the commands that would be executed instead.
+     * 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.
-     *
-     * @experimental
      */
     readonly dryRun?: boolean;
 }
 /**
- * (experimental) Implements GitHub jobs for publishing modules to package managers.
+ * Implements GitHub jobs for publishing modules to package managers.
  *
  * Under the hood, it uses https://github.com/aws/jsii-release
- *
- * @experimental
  */
 export declare class Publisher extends Component {
-    /**
-     * @experimental
-     */
     readonly buildJobId: string;
-    /**
-     * @experimental
-     */
     readonly artifactName: string;
-    /**
-     * @experimental
-     */
     readonly jsiiReleaseVersion: string;
-    /**
-     * @experimental
-     */
     readonly condition?: string;
     private readonly failureIssue;
     private readonly failureIssueLabel;
@@ -114,9 +83,6 @@ export declare class Publisher extends Component {
     private readonly _jobFactories;
     private readonly _gitHubPrePublishing;
     private readonly dryRun;
-    /**
-     * @experimental
-     */
     constructor(project: Project, options: PublisherOptions);
     /**
      * Called by `Release` to add the publishing jobs to a release workflow
@@ -128,88 +94,69 @@ export declare class Publisher extends Component {
      */
     _renderJobsForBranch(branch: string, options: Partial<BranchOptions>): Record<string, Job>;
     /**
-     * (experimental) Adds pre publishing steps for the GitHub release job.
+     * Adds pre publishing steps for the GitHub release job.
      *
      * @param steps The steps.
-     * @experimental
      */
     addGitHubPrePublishingSteps(...steps: JobStep[]): void;
     /**
-     * (experimental) Publish to git.
+     * Publish to git.
      *
      * This includes generating a project-level changelog and release tags.
      *
-     * @param options Options.
-     * @experimental
+     * @param options Options
      */
     publishToGit(options: GitPublishOptions): import("..").Task;
     /**
-     * (experimental) Creates a GitHub Release.
-     *
-     * @param options Options.
-     * @experimental
+     * Creates a GitHub Release.
+     * @param options Options
      */
     publishToGitHubReleases(options: GitHubReleasesPublishOptions): void;
     /**
-     * (experimental) Publishes artifacts from `js/**` to npm.
-     *
-     * @param options Options.
-     * @experimental
+     * Publishes artifacts from `js/**` to npm.
+     * @param options Options
      */
     publishToNpm(options?: NpmPublishOptions): void;
     /**
-     * (experimental) Publishes artifacts from `dotnet/**` to NuGet Gallery.
-     *
-     * @param options Options.
-     * @experimental
+     * Publishes artifacts from `dotnet/**` to NuGet Gallery.
+     * @param options Options
      */
     publishToNuget(options?: NugetPublishOptions): void;
     /**
-     * (experimental) Publishes artifacts from `java/**` to Maven.
-     *
-     * @param options Options.
-     * @experimental
+     * Publishes artifacts from `java/**` to Maven.
+     * @param options Options
      */
     publishToMaven(options?: MavenPublishOptions): void;
     /**
-     * (experimental) Publishes wheel artifacts from `python` to PyPI.
-     *
-     * @param options Options.
-     * @experimental
+     * Publishes wheel artifacts from `python` to PyPI.
+     * @param options Options
      */
     publishToPyPi(options?: PyPiPublishOptions): void;
     /**
-     * (experimental) Adds a go publishing job.
-     *
-     * @param options Options.
-     * @experimental
+     * Adds a go publishing job.
+     * @param options Options
      */
     publishToGo(options?: GoPublishOptions): void;
     private addPublishJob;
     private jsiiReleaseCommand;
 }
 /**
- * (experimental) Common publishing options.
- *
- * @experimental
+ * Common publishing options
  */
 export interface CommonPublishOptions {
     /**
-     * (experimental) Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.
+     * Steps to execute before executing the publishing command. These can be used
+     * to prepare the artifact for publishing if neede.
      *
      * 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`.
-     *
-     * @experimental
      */
     readonly prePublishSteps?: JobStep[];
     /**
-     * (experimental) Additional tools to install in the publishing job.
-     *
+     * Additional tools to install in the publishing job.
      * @default - no additional tools are installed
-     * @experimental
      */
     readonly publishTools?: Tools;
 }
@@ -219,13 +166,11 @@ export interface CommonPublishOptions {
 export interface JsiiReleaseNpm extends NpmPublishOptions {
 }
 /**
- * (experimental) Options for npm release.
- *
- * @experimental
+ * Options for npm release
  */
 export interface NpmPublishOptions extends CommonPublishOptions {
     /**
-     * (deprecated) Tags can be used to provide an alias instead of version numbers.
+     * 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.
@@ -243,7 +188,7 @@ export interface NpmPublishOptions extends CommonPublishOptions {
      */
     readonly distTag?: string;
     /**
-     * (experimental) The domain name of the npm package registry.
+     * 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
@@ -252,54 +197,41 @@ export interface NpmPublishOptions extends CommonPublishOptions {
      * correctly defined.
      *
      * @default "registry.npmjs.org"
-     * @experimental
-     * @example
-     *
-     * "npm.pkg.github.com"
+     * @example "npm.pkg.github.com"
      */
     readonly registry?: string;
     /**
-     * (experimental) GitHub secret which contains the NPM token to use when publishing packages.
-     *
+     * GitHub secret which contains the NPM token to use when publishing packages.
      * @default - "NPM_TOKEN" or "GITHUB_TOKEN" if `registry` is set to `npm.pkg.github.com`.
-     * @experimental
      */
     readonly npmTokenSecret?: string;
     /**
-     * (experimental) Options for publishing npm package to AWS CodeArtifact.
+     * Options for publishing npm package to AWS CodeArtifact.
      *
      * @default - undefined
-     * @experimental
      */
     readonly codeArtifactOptions?: CodeArtifactOptions;
 }
-/**
- * @experimental
- */
 export interface CodeArtifactOptions {
     /**
-     * (experimental) GitHub secret which contains the AWS access key ID to use when publishing packages to AWS CodeArtifact.
-     *
+     * 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 (`registry` contains AWS CodeArtifact URL).
      *
      * @default "AWS_ACCESS_KEY_ID"
-     * @experimental
      */
     readonly accessKeyIdSecret?: string;
     /**
-     * (experimental) GitHub secret which contains the AWS secret access key to use when publishing packages to AWS CodeArtifact.
-     *
+     * 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 (`registry` contains AWS CodeArtifact URL).
      *
      * @default "AWS_SECRET_ACCESS_KEY"
-     * @experimental
      */
     readonly secretAccessKeySecret?: string;
     /**
-     * (experimental) 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).
+     * 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).
      *
      * @default undefined
-     * @experimental
      */
     readonly roleToAssume?: string;
 }
@@ -309,30 +241,23 @@ export interface CodeArtifactOptions {
 export interface JsiiReleasePyPi extends PyPiPublishOptions {
 }
 /**
- * (experimental) Options for PyPI release.
- *
- * @experimental
+ * Options for PyPI release
  */
 export interface PyPiPublishOptions extends CommonPublishOptions {
     /**
-     * (experimental) The registry url to use when releasing packages.
+     * The registry url to use when releasing packages.
      *
      * @default - twine default
-     * @experimental
      */
     readonly twineRegistryUrl?: string;
     /**
-     * (experimental) The GitHub secret which contains PyPI user name.
-     *
+     * The GitHub secret which contains PyPI user name.
      * @default "TWINE_USERNAME"
-     * @experimental
      */
     readonly twineUsernameSecret?: string;
     /**
-     * (experimental) The GitHub secret which contains PyPI password.
-     *
+     * The GitHub secret which contains PyPI password.
      * @default "TWINE_PASSWORD"
-     * @experimental
      */
     readonly twinePasswordSecret?: string;
 }
@@ -342,16 +267,13 @@ export interface PyPiPublishOptions extends CommonPublishOptions {
 export interface JsiiReleaseNuget extends NugetPublishOptions {
 }
 /**
- * (experimental) Options for NuGet releases.
- *
- * @experimental
+ * Options for NuGet releases
  */
 export interface NugetPublishOptions extends CommonPublishOptions {
     /**
-     * (experimental) GitHub secret which contains the API key for NuGet.
+     * GitHub secret which contains the API key for NuGet.
      *
      * @default "NUGET_API_KEY"
-     * @experimental
      */
     readonly nugetApiKeySecret?: string;
 }
@@ -361,162 +283,140 @@ export interface NugetPublishOptions extends CommonPublishOptions {
 export interface JsiiReleaseMaven extends MavenPublishOptions {
 }
 /**
- * (experimental) Options for Maven releases.
- *
- * @experimental
+ * Options for Maven releases
  */
 export interface MavenPublishOptions extends CommonPublishOptions {
     /**
-     * (experimental) URL of Nexus repository.
-     *
-     * if not set, defaults to https://oss.sonatype.org
+     * URL of Nexus repository. if not set, defaults to https://oss.sonatype.org
      *
      * @default "https://oss.sonatype.org"
-     * @experimental
      */
     readonly mavenEndpoint?: string;
     /**
-     * (experimental) Used in maven settings for credential lookup (e.g. use github when publishing to GitHub).
+     * Used in maven settings for credential lookup (e.g. use github when publishing to GitHub).
      *
      * @default "ossrh" (Maven Central) or "github" when using GitHub Packages
-     * @experimental
      */
     readonly mavenServerId?: string;
     /**
-     * (experimental) Deployment repository when not deploying to Maven Central.
+     * Deployment repository when not deploying to Maven Central
      *
      * @default - not set
-     * @experimental
      */
     readonly mavenRepositoryUrl?: string;
     /**
-     * (experimental) GitHub secret name which contains the GPG private key or file that includes it.
-     *
-     * This is used to sign your Maven
+     * GitHub secret name which contains the GPG private key or file that includes
+     * it. This is used to sign your Maven
      * packages. See instructions.
      *
-     * @default "MAVEN_GPG_PRIVATE_KEY" or not set when using GitHub Packages
      * @see https://github.com/aws/jsii-release#maven
-     * @experimental
+     * @default "MAVEN_GPG_PRIVATE_KEY" or not set when using GitHub Packages
      */
     readonly mavenGpgPrivateKeySecret?: string;
     /**
-     * (experimental) GitHub secret name which contains the GPG private key or file that includes it.
-     *
-     * This is used to sign your Maven packages. See instructions.
+     * GitHub secret name which contains the GPG private key or file that includes
+     * it. This is used to sign your Maven packages. See instructions.
      *
-     * @default "MAVEN_GPG_PRIVATE_KEY_PASSPHRASE" or not set when using GitHub Packages
      * @see https://github.com/aws/jsii-release#maven
-     * @experimental
+     * @default "MAVEN_GPG_PRIVATE_KEY_PASSPHRASE" or not set when using GitHub Packages
      */
     readonly mavenGpgPrivateKeyPassphrase?: string;
     /**
-     * (experimental) GitHub secret name which contains the Username for maven repository.
+     * 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).
      *
-     * @default "MAVEN_USERNAME" or the GitHub Actor when using GitHub Packages
+     * @see https://issues.sonatype.org/secure/Signup
      * @see https://issues.sonatype.org/secure/CreateIssue.jspa?issuetype=21&pid=10134
-     * @experimental
+     *
+     * @default "MAVEN_USERNAME" or the GitHub Actor when using GitHub Packages
      */
     readonly mavenUsername?: string;
     /**
-     * (experimental) GitHub secret name which contains the Password for maven repository.
+     * 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).
      *
-     * @default "MAVEN_PASSWORD" or "GITHUB_TOKEN" when using GitHub Packages
+     * @see https://issues.sonatype.org/secure/Signup
      * @see https://issues.sonatype.org/secure/CreateIssue.jspa?issuetype=21&pid=10134
-     * @experimental
+     *
+     * @default "MAVEN_PASSWORD" or "GITHUB_TOKEN" when using GitHub Packages
      */
     readonly mavenPassword?: string;
     /**
-     * (experimental) 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).
-     *
+     * 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)
+  
      * @default "MAVEN_STAGING_PROFILE_ID" or not set when using GitHub Packages
-     * @experimental
      */
     readonly mavenStagingProfileId?: string;
 }
 /**
  * @deprecated Use `GoPublishOptions` instead.
- * export interface JsiiReleaseGo extends GoPublishOptions { }
- * /**
+export interface JsiiReleaseGo extends GoPublishOptions { }
+
+/**
  * Options for Go releases.
  */
 export interface GoPublishOptions extends CommonPublishOptions {
     /**
-     * (deprecated) The name of the secret that includes a personal GitHub access token used to push to the GitHub repository.
+     * The name of the secret that includes a personal GitHub access token used to
+     * push to the GitHub repository.
      *
      * @default "GO_GITHUB_TOKEN"
-     * @deprecated
      */
     readonly githubTokenSecret?: string;
     /**
-     * (deprecated) GitHub repository to push to.
+     * GitHub repository to push to.
      *
      * @default - derived from `moduleName`
-     * @deprecated
      */
     readonly githubRepo?: string;
     /**
-     * (deprecated) Branch to push to.
+     * Branch to push to.
      *
      * @default "main"
-     * @deprecated
      */
     readonly gitBranch?: string;
     /**
-     * (deprecated) The user name to use for the release git commit.
-     *
+     * The user name to use for the release git commit.
      * @default "github-actions"
-     * @deprecated
      */
     readonly gitUserName?: string;
     /**
-     * (deprecated) The email to use in the release git commit.
-     *
-     * @default "github-actions
-     * @deprecated
-     * @github .com"
+     * The email to use in the release git commit.
+     * @default "github-actions@github.com"
      */
     readonly gitUserEmail?: string;
     /**
-     * (deprecated) The commit message.
+     * The commit message.
      *
      * @default "chore(release): $VERSION"
-     * @deprecated
      */
     readonly gitCommitMessage?: string;
 }
 interface VersionArtifactOptions {
     /**
-     * (experimental) The location of a text file (relative to `dist/`) that contains the version number.
+     * The location of a text file (relative to `dist/`) that contains the version number.
      *
-     * @experimental
-     * @example
-     *
-     * version.txt
+     * @example version.txt
      */
     readonly versionFile: string;
     /**
-     * (experimental) The location of a text file (relative to `dist/`) that contains the release tag.
-     *
-     * @experimental
-     * @example
+     * The location of a text file (relative to `dist/`) that contains the release tag.
      *
-     * releasetag.txt
+     * @example releasetag.txt
      */
     readonly releaseTagFile: string;
     /**
-     * (experimental) The location of an .md file (relative to `dist/`) that includes the changelog for the release.
+     * The location of an .md file (relative to `dist/`) that includes the changelog for the release.
      *
-     * @experimental
-     * @example
-     *
-     * changelog.md
+     * @example changelog.md
      */
     readonly changelogFile: string;
 }
@@ -527,37 +427,28 @@ interface VersionArtifactOptions {
  */
 export declare function isAwsCodeArtifactRegistry(registryUrl: string | undefined): boolean | "" | undefined;
 /**
- * (experimental) Publishing options for GitHub releases.
- *
- * @experimental
+ * Publishing options for GitHub releases.
  */
 export interface GitHubReleasesPublishOptions extends VersionArtifactOptions, CommonPublishOptions {
 }
 /**
- * (experimental) Publishing options for Git releases.
- *
- * @experimental
+ * Publishing options for Git releases
  */
 export interface GitPublishOptions extends VersionArtifactOptions {
     /**
-     * (experimental) The location of an .md file that includes the project-level changelog.
-     *
-     * @experimental
+     * The location of an .md file that includes the project-level changelog.
      */
     readonly projectChangelogFile?: string;
     /**
-     * (experimental) Branch to push to.
+     * Branch to push to.
      *
      * @default "main"
-     * @experimental
      */
     readonly gitBranch?: string;
     /**
-     * (experimental) Override git-push command.
+     * Override git-push command.
      *
      * Set to an empty string to disable pushing.
-     *
-     * @experimental
      */
     readonly gitPushCommand?: string;
 }