# API Reference ## Constructs ### AssignApprover #### Initializers ```typescript import { AssignApprover } from 'projen-pipelines' new AssignApprover(scope: Project, baseOptions: AssignApproverOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | projen.Project | *No description.* | | baseOptions | AssignApproverOptions | *No description.* | --- ##### `scope`^Required - *Type:* projen.Project --- ##### `baseOptions`^Required - *Type:* AssignApproverOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | postProjectCreation | Called once, right after `postSynthesize()`, only when the project is created for the first time. | | postSynthesize | Called after synthesis. | | preSynthesize | Called before synthesis. | | projectCreation | Called once, right after `synthesize()`, only when the project is created for the first time. | | synthesize | Synthesizes files to the project output directory. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `postProjectCreation` ```typescript public postProjectCreation(initProject: InitProject): void ``` Called once, right after `postSynthesize()`, only when the project is created for the first time. It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`). It is also skipped when post-synthesis steps are disabled, e.g. `--no-post` or `PROJEN_DISABLE_POST`. Use it for one-off setup that can be turned off by the user, like running a task to give the user immediate feedback on their new project. Order across components is not guaranteed. ###### `initProject`^Required - *Type:* projen.InitProject Details about how the project was created, e.g. its type and the original CLI args. --- ##### `postSynthesize` ```typescript public postSynthesize(): void ``` Called after synthesis. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before synthesis. ##### `projectCreation` ```typescript public projectCreation(initProject: InitProject): void ``` Called once, right after `synthesize()`, only when the project is created for the first time. It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`). Use it for deterministic, one-off file generation. Order across components is not guaranteed. ###### `initProject`^Required - *Type:* projen.InitProject Details about how the project was created, e.g. its type and the original CLI args. --- ##### `synthesize` ```typescript public synthesize(): void ``` Synthesizes files to the project output directory. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isComponent | Test whether the given construct is a component. | --- ##### `isConstruct` ```typescript import { AssignApprover } from 'projen-pipelines' AssignApprover.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` ```typescript import { AssignApprover } from 'projen-pipelines' AssignApprover.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.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `project`^Required ```typescript public readonly project: Project; ``` - *Type:* projen.Project --- ### BashCDKPipeline #### Initializers ```typescript import { BashCDKPipeline } from 'projen-pipelines' new BashCDKPipeline(app: AwsCdkTypeScriptApp, options: BashCDKPipelineOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | app | projen.awscdk.AwsCdkTypeScriptApp | *No description.* | | options | BashCDKPipelineOptions | *No description.* | --- ##### `app`^Required - *Type:* projen.awscdk.AwsCdkTypeScriptApp --- ##### `options`^Required - *Type:* BashCDKPipelineOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | postProjectCreation | Called once, right after `postSynthesize()`, only when the project is created for the first time. | | postSynthesize | Called after synthesis. | | preSynthesize | Called before synthesis. | | projectCreation | Called once, right after `synthesize()`, only when the project is created for the first time. | | synthesize | Synthesizes files to the project output directory. | | engineType | *No description.* | | generateVersioningAppCode | Generate CDK application code for versioning. | | generateVersioningImports | Generate versioning imports for CDK application. | | generateVersioningUtilities | Generate versioning utility functions for CDK application. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `postProjectCreation` ```typescript public postProjectCreation(initProject: InitProject): void ``` Called once, right after `postSynthesize()`, only when the project is created for the first time. It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`). It is also skipped when post-synthesis steps are disabled, e.g. `--no-post` or `PROJEN_DISABLE_POST`. Use it for one-off setup that can be turned off by the user, like running a task to give the user immediate feedback on their new project. Order across components is not guaranteed. ###### `initProject`^Required - *Type:* projen.InitProject Details about how the project was created, e.g. its type and the original CLI args. --- ##### `postSynthesize` ```typescript public postSynthesize(): void ``` Called after synthesis. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before synthesis. ##### `projectCreation` ```typescript public projectCreation(initProject: InitProject): void ``` Called once, right after `synthesize()`, only when the project is created for the first time. It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`). Use it for deterministic, one-off file generation. Order across components is not guaranteed. ###### `initProject`^Required - *Type:* projen.InitProject Details about how the project was created, e.g. its type and the original CLI args. --- ##### `synthesize` ```typescript public synthesize(): void ``` Synthesizes files to the project output directory. ##### `engineType` ```typescript public engineType(): PipelineEngine ``` ##### `generateVersioningAppCode` ```typescript public generateVersioningAppCode(config: VersioningConfig): string ``` Generate CDK application code for versioning. ###### `config`^Required - *Type:* VersioningConfig --- ##### `generateVersioningImports` ```typescript public generateVersioningImports(): string ``` Generate versioning imports for CDK application. ##### `generateVersioningUtilities` ```typescript public generateVersioningUtilities(): string ``` Generate versioning utility functions for CDK application. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isComponent | Test whether the given construct is a component. | --- ##### `isConstruct` ```typescript import { BashCDKPipeline } from 'projen-pipelines' BashCDKPipeline.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` ```typescript import { BashCDKPipeline } from 'projen-pipelines' BashCDKPipeline.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.* | | branchName | string | *No description.* | | stackPrefix | string | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `project`^Required ```typescript public readonly project: Project; ``` - *Type:* projen.Project --- ##### `branchName`^Required ```typescript public readonly branchName: string; ``` - *Type:* string --- ##### `stackPrefix`^Required ```typescript public readonly stackPrefix: string; ``` - *Type:* string --- ### BashDriftDetectionWorkflow #### Initializers ```typescript import { BashDriftDetectionWorkflow } from 'projen-pipelines' new BashDriftDetectionWorkflow(project: Project, options: BashDriftDetectionWorkflowOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | projen.Project | *No description.* | | options | BashDriftDetectionWorkflowOptions | *No description.* | --- ##### `project`^Required - *Type:* projen.Project --- ##### `options`^Required - *Type:* BashDriftDetectionWorkflowOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | postProjectCreation | Called once, right after `postSynthesize()`, only when the project is created for the first time. | | postSynthesize | Called after synthesis. | | preSynthesize | Called before synthesis. | | projectCreation | Called once, right after `synthesize()`, only when the project is created for the first time. | | synthesize | Synthesizes files to the project output directory. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `postProjectCreation` ```typescript public postProjectCreation(initProject: InitProject): void ``` Called once, right after `postSynthesize()`, only when the project is created for the first time. It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`). It is also skipped when post-synthesis steps are disabled, e.g. `--no-post` or `PROJEN_DISABLE_POST`. Use it for one-off setup that can be turned off by the user, like running a task to give the user immediate feedback on their new project. Order across components is not guaranteed. ###### `initProject`^Required - *Type:* projen.InitProject Details about how the project was created, e.g. its type and the original CLI args. --- ##### `postSynthesize` ```typescript public postSynthesize(): void ``` Called after synthesis. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before synthesis. ##### `projectCreation` ```typescript public projectCreation(initProject: InitProject): void ``` Called once, right after `synthesize()`, only when the project is created for the first time. It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`). Use it for deterministic, one-off file generation. Order across components is not guaranteed. ###### `initProject`^Required - *Type:* projen.InitProject Details about how the project was created, e.g. its type and the original CLI args. --- ##### `synthesize` ```typescript public synthesize(): void ``` Synthesizes files to the project output directory. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isComponent | Test whether the given construct is a component. | --- ##### `isConstruct` ```typescript import { BashDriftDetectionWorkflow } from 'projen-pipelines' BashDriftDetectionWorkflow.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` ```typescript import { BashDriftDetectionWorkflow } from 'projen-pipelines' BashDriftDetectionWorkflow.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.* | | name | string | *No description.* | | schedule | string | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `project`^Required ```typescript public readonly project: Project; ``` - *Type:* projen.Project --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `schedule`^Required ```typescript public readonly schedule: string; ``` - *Type:* string --- ### CDKPipeline The CDKPipeline class extends the Component class and sets up the necessary configuration for deploying AWS CDK (Cloud Development Kit) applications across multiple stages. It also manages tasks such as publishing CDK assets, bumping version based on git tags, and cleaning up conflicting tasks. #### Initializers ```typescript import { CDKPipeline } from 'projen-pipelines' new CDKPipeline(app: AwsCdkTypeScriptApp, baseOptions: CDKPipelineOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | app | projen.awscdk.AwsCdkTypeScriptApp | *No description.* | | baseOptions | CDKPipelineOptions | *No description.* | --- ##### `app`^Required - *Type:* projen.awscdk.AwsCdkTypeScriptApp --- ##### `baseOptions`^Required - *Type:* CDKPipelineOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | postProjectCreation | Called once, right after `postSynthesize()`, only when the project is created for the first time. | | postSynthesize | Called after synthesis. | | preSynthesize | Called before synthesis. | | projectCreation | Called once, right after `synthesize()`, only when the project is created for the first time. | | synthesize | Synthesizes files to the project output directory. | | engineType | *No description.* | | generateVersioningAppCode | Generate CDK application code for versioning. | | generateVersioningImports | Generate versioning imports for CDK application. | | generateVersioningUtilities | Generate versioning utility functions for CDK application. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `postProjectCreation` ```typescript public postProjectCreation(initProject: InitProject): void ``` Called once, right after `postSynthesize()`, only when the project is created for the first time. It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`). It is also skipped when post-synthesis steps are disabled, e.g. `--no-post` or `PROJEN_DISABLE_POST`. Use it for one-off setup that can be turned off by the user, like running a task to give the user immediate feedback on their new project. Order across components is not guaranteed. ###### `initProject`^Required - *Type:* projen.InitProject Details about how the project was created, e.g. its type and the original CLI args. --- ##### `postSynthesize` ```typescript public postSynthesize(): void ``` Called after synthesis. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before synthesis. ##### `projectCreation` ```typescript public projectCreation(initProject: InitProject): void ``` Called once, right after `synthesize()`, only when the project is created for the first time. It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`). Use it for deterministic, one-off file generation. Order across components is not guaranteed. ###### `initProject`^Required - *Type:* projen.InitProject Details about how the project was created, e.g. its type and the original CLI args. --- ##### `synthesize` ```typescript public synthesize(): void ``` Synthesizes files to the project output directory. ##### `engineType` ```typescript public engineType(): PipelineEngine ``` ##### `generateVersioningAppCode` ```typescript public generateVersioningAppCode(config: VersioningConfig): string ``` Generate CDK application code for versioning. ###### `config`^Required - *Type:* VersioningConfig --- ##### `generateVersioningImports` ```typescript public generateVersioningImports(): string ``` Generate versioning imports for CDK application. ##### `generateVersioningUtilities` ```typescript public generateVersioningUtilities(): string ``` Generate versioning utility functions for CDK application. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isComponent | Test whether the given construct is a component. | --- ##### `isConstruct` ```typescript import { CDKPipeline } from 'projen-pipelines' CDKPipeline.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` ```typescript import { CDKPipeline } from 'projen-pipelines' CDKPipeline.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.* | | branchName | string | *No description.* | | stackPrefix | string | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `project`^Required ```typescript public readonly project: Project; ``` - *Type:* projen.Project --- ##### `branchName`^Required ```typescript public readonly branchName: string; ``` - *Type:* string --- ##### `stackPrefix`^Required ```typescript public readonly stackPrefix: string; ``` - *Type:* string --- ### DriftDetectionWorkflow #### Initializers ```typescript import { DriftDetectionWorkflow } from 'projen-pipelines' new DriftDetectionWorkflow(project: Project, options: DriftDetectionWorkflowOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | projen.Project | *No description.* | | options | DriftDetectionWorkflowOptions | *No description.* | --- ##### `project`^Required - *Type:* projen.Project --- ##### `options`^Required - *Type:* DriftDetectionWorkflowOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | postProjectCreation | Called once, right after `postSynthesize()`, only when the project is created for the first time. | | postSynthesize | Called after synthesis. | | preSynthesize | Called before synthesis. | | projectCreation | Called once, right after `synthesize()`, only when the project is created for the first time. | | synthesize | Synthesizes files to the project output directory. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `postProjectCreation` ```typescript public postProjectCreation(initProject: InitProject): void ``` Called once, right after `postSynthesize()`, only when the project is created for the first time. It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`). It is also skipped when post-synthesis steps are disabled, e.g. `--no-post` or `PROJEN_DISABLE_POST`. Use it for one-off setup that can be turned off by the user, like running a task to give the user immediate feedback on their new project. Order across components is not guaranteed. ###### `initProject`^Required - *Type:* projen.InitProject Details about how the project was created, e.g. its type and the original CLI args. --- ##### `postSynthesize` ```typescript public postSynthesize(): void ``` Called after synthesis. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before synthesis. ##### `projectCreation` ```typescript public projectCreation(initProject: InitProject): void ``` Called once, right after `synthesize()`, only when the project is created for the first time. It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`). Use it for deterministic, one-off file generation. Order across components is not guaranteed. ###### `initProject`^Required - *Type:* projen.InitProject Details about how the project was created, e.g. its type and the original CLI args. --- ##### `synthesize` ```typescript public synthesize(): void ``` Synthesizes files to the project output directory. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isComponent | Test whether the given construct is a component. | --- ##### `isConstruct` ```typescript import { DriftDetectionWorkflow } from 'projen-pipelines' DriftDetectionWorkflow.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` ```typescript import { DriftDetectionWorkflow } from 'projen-pipelines' DriftDetectionWorkflow.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.* | | name | string | *No description.* | | schedule | string | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `project`^Required ```typescript public readonly project: Project; ``` - *Type:* projen.Project --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `schedule`^Required ```typescript public readonly schedule: string; ``` - *Type:* string --- ### GitHubAssignApprover #### Initializers ```typescript import { GitHubAssignApprover } from 'projen-pipelines' new GitHubAssignApprover(scope: GitHubProject, options: GitHubAssignApproverOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | projen.github.GitHubProject | *No description.* | | options | GitHubAssignApproverOptions | *No description.* | --- ##### `scope`^Required - *Type:* projen.github.GitHubProject --- ##### `options`^Required - *Type:* GitHubAssignApproverOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | postProjectCreation | Called once, right after `postSynthesize()`, only when the project is created for the first time. | | postSynthesize | Called after synthesis. | | preSynthesize | Called before synthesis. | | projectCreation | Called once, right after `synthesize()`, only when the project is created for the first time. | | synthesize | Synthesizes files to the project output directory. | | renderPermissions | Get the required permissions for the GitHub workflow. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `postProjectCreation` ```typescript public postProjectCreation(initProject: InitProject): void ``` Called once, right after `postSynthesize()`, only when the project is created for the first time. It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`). It is also skipped when post-synthesis steps are disabled, e.g. `--no-post` or `PROJEN_DISABLE_POST`. Use it for one-off setup that can be turned off by the user, like running a task to give the user immediate feedback on their new project. Order across components is not guaranteed. ###### `initProject`^Required - *Type:* projen.InitProject Details about how the project was created, e.g. its type and the original CLI args. --- ##### `postSynthesize` ```typescript public postSynthesize(): void ``` Called after synthesis. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before synthesis. ##### `projectCreation` ```typescript public projectCreation(initProject: InitProject): void ``` Called once, right after `synthesize()`, only when the project is created for the first time. It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`). Use it for deterministic, one-off file generation. Order across components is not guaranteed. ###### `initProject`^Required - *Type:* projen.InitProject Details about how the project was created, e.g. its type and the original CLI args. --- ##### `synthesize` ```typescript public synthesize(): void ``` Synthesizes files to the project output directory. ##### `renderPermissions` ```typescript public renderPermissions(): JobPermissions ``` Get the required permissions for the GitHub workflow. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isComponent | Test whether the given construct is a component. | --- ##### `isConstruct` ```typescript import { GitHubAssignApprover } from 'projen-pipelines' GitHubAssignApprover.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` ```typescript import { GitHubAssignApprover } from 'projen-pipelines' GitHubAssignApprover.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.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `project`^Required ```typescript public readonly project: Project; ``` - *Type:* projen.Project --- ### GithubCDKPipeline Implements a CDK Pipeline configured specifically for GitHub workflows. #### Initializers ```typescript import { GithubCDKPipeline } from 'projen-pipelines' new GithubCDKPipeline(app: AwsCdkTypeScriptApp, options: GithubCDKPipelineOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | app | projen.awscdk.AwsCdkTypeScriptApp | - The CDK app associated with this pipeline. | | options | GithubCDKPipelineOptions | - Configuration options for the pipeline. | --- ##### `app`^Required - *Type:* projen.awscdk.AwsCdkTypeScriptApp The CDK app associated with this pipeline. --- ##### `options`^Required - *Type:* GithubCDKPipelineOptions Configuration options for the pipeline. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | postProjectCreation | Called once, right after `postSynthesize()`, only when the project is created for the first time. | | postSynthesize | Called after synthesis. | | preSynthesize | Called before synthesis. | | projectCreation | Called once, right after `synthesize()`, only when the project is created for the first time. | | synthesize | Synthesizes files to the project output directory. | | engineType | the type of engine this implementation of CDKPipeline is for. | | generateVersioningAppCode | Generate CDK application code for versioning. | | generateVersioningImports | Generate versioning imports for CDK application. | | generateVersioningUtilities | Generate versioning utility functions for CDK application. | | createAssetUpload | Creates a job to upload assets to AWS as part of the pipeline. | | createDeployment | Creates a job to deploy the CDK application to AWS. | | createIndependentDeployment | Creates a job to deploy the CDK application to AWS. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `postProjectCreation` ```typescript public postProjectCreation(initProject: InitProject): void ``` Called once, right after `postSynthesize()`, only when the project is created for the first time. It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`). It is also skipped when post-synthesis steps are disabled, e.g. `--no-post` or `PROJEN_DISABLE_POST`. Use it for one-off setup that can be turned off by the user, like running a task to give the user immediate feedback on their new project. Order across components is not guaranteed. ###### `initProject`^Required - *Type:* projen.InitProject Details about how the project was created, e.g. its type and the original CLI args. --- ##### `postSynthesize` ```typescript public postSynthesize(): void ``` Called after synthesis. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before synthesis. ##### `projectCreation` ```typescript public projectCreation(initProject: InitProject): void ``` Called once, right after `synthesize()`, only when the project is created for the first time. It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`). Use it for deterministic, one-off file generation. Order across components is not guaranteed. ###### `initProject`^Required - *Type:* projen.InitProject Details about how the project was created, e.g. its type and the original CLI args. --- ##### `synthesize` ```typescript public synthesize(): void ``` Synthesizes files to the project output directory. ##### `engineType` ```typescript public engineType(): PipelineEngine ``` the type of engine this implementation of CDKPipeline is for. ##### `generateVersioningAppCode` ```typescript public generateVersioningAppCode(config: VersioningConfig): string ``` Generate CDK application code for versioning. ###### `config`^Required - *Type:* VersioningConfig --- ##### `generateVersioningImports` ```typescript public generateVersioningImports(): string ``` Generate versioning imports for CDK application. ##### `generateVersioningUtilities` ```typescript public generateVersioningUtilities(): string ``` Generate versioning utility functions for CDK application. ##### `createAssetUpload` ```typescript public createAssetUpload(stageName?: string, githubEnvironment?: string): void ``` Creates a job to upload assets to AWS as part of the pipeline. ###### `stageName`^Optional - *Type:* string --- ###### `githubEnvironment`^Optional - *Type:* string --- ##### `createDeployment` ```typescript public createDeployment(stage: DeploymentStage, useGithubEnvironmentsForAssetUpload?: boolean): void ``` Creates a job to deploy the CDK application to AWS. ###### `stage`^Required - *Type:* DeploymentStage The deployment stage to create. --- ###### `useGithubEnvironmentsForAssetUpload`^Optional - *Type:* boolean --- ##### `createIndependentDeployment` ```typescript public createIndependentDeployment(stage: IndependentStage): void ``` Creates a job to deploy the CDK application to AWS. ###### `stage`^Required - *Type:* IndependentStage The independent stage to create. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isComponent | Test whether the given construct is a component. | --- ##### `isConstruct` ```typescript import { GithubCDKPipeline } from 'projen-pipelines' GithubCDKPipeline.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` ```typescript import { GithubCDKPipeline } from 'projen-pipelines' GithubCDKPipeline.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.* | | branchName | string | *No description.* | | stackPrefix | string | *No description.* | | needsVersionedArtifacts | boolean | Indicates if versioned artifacts are needed based on manual approval requirements. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `project`^Required ```typescript public readonly project: Project; ``` - *Type:* projen.Project --- ##### `branchName`^Required ```typescript public readonly branchName: string; ``` - *Type:* string --- ##### `stackPrefix`^Required ```typescript public readonly stackPrefix: string; ``` - *Type:* string --- ##### `needsVersionedArtifacts`^Required ```typescript public readonly needsVersionedArtifacts: boolean; ``` - *Type:* boolean Indicates if versioned artifacts are needed based on manual approval requirements. --- ### GitHubDriftDetectionWorkflow #### Initializers ```typescript import { GitHubDriftDetectionWorkflow } from 'projen-pipelines' new GitHubDriftDetectionWorkflow(project: Project, options: GitHubDriftDetectionWorkflowOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | projen.Project | *No description.* | | options | GitHubDriftDetectionWorkflowOptions | *No description.* | --- ##### `project`^Required - *Type:* projen.Project --- ##### `options`^Required - *Type:* GitHubDriftDetectionWorkflowOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | postProjectCreation | Called once, right after `postSynthesize()`, only when the project is created for the first time. | | postSynthesize | Called after synthesis. | | preSynthesize | Called before synthesis. | | projectCreation | Called once, right after `synthesize()`, only when the project is created for the first time. | | synthesize | Synthesizes files to the project output directory. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `postProjectCreation` ```typescript public postProjectCreation(initProject: InitProject): void ``` Called once, right after `postSynthesize()`, only when the project is created for the first time. It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`). It is also skipped when post-synthesis steps are disabled, e.g. `--no-post` or `PROJEN_DISABLE_POST`. Use it for one-off setup that can be turned off by the user, like running a task to give the user immediate feedback on their new project. Order across components is not guaranteed. ###### `initProject`^Required - *Type:* projen.InitProject Details about how the project was created, e.g. its type and the original CLI args. --- ##### `postSynthesize` ```typescript public postSynthesize(): void ``` Called after synthesis. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before synthesis. ##### `projectCreation` ```typescript public projectCreation(initProject: InitProject): void ``` Called once, right after `synthesize()`, only when the project is created for the first time. It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`). Use it for deterministic, one-off file generation. Order across components is not guaranteed. ###### `initProject`^Required - *Type:* projen.InitProject Details about how the project was created, e.g. its type and the original CLI args. --- ##### `synthesize` ```typescript public synthesize(): void ``` Synthesizes files to the project output directory. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isComponent | Test whether the given construct is a component. | --- ##### `isConstruct` ```typescript import { GitHubDriftDetectionWorkflow } from 'projen-pipelines' GitHubDriftDetectionWorkflow.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` ```typescript import { GitHubDriftDetectionWorkflow } from 'projen-pipelines' GitHubDriftDetectionWorkflow.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.* | | name | string | *No description.* | | schedule | string | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `project`^Required ```typescript public readonly project: Project; ``` - *Type:* projen.Project --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `schedule`^Required ```typescript public readonly schedule: string; ``` - *Type:* string --- ### GitlabCDKPipeline The GitlabCDKPipeline class extends CDKPipeline to provide a way to configure and execute AWS CDK deployment pipelines within GitLab CI/CD environments. It integrates IAM role management, runner configuration, and defines stages and jobs for the deployment workflow. #### Initializers ```typescript import { GitlabCDKPipeline } from 'projen-pipelines' new GitlabCDKPipeline(app: AwsCdkTypeScriptApp, options: GitlabCDKPipelineOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | app | projen.awscdk.AwsCdkTypeScriptApp | - The AWS CDK app associated with the pipeline. | | options | GitlabCDKPipelineOptions | - Configuration options for the pipeline. | --- ##### `app`^Required - *Type:* projen.awscdk.AwsCdkTypeScriptApp The AWS CDK app associated with the pipeline. --- ##### `options`^Required - *Type:* GitlabCDKPipelineOptions Configuration options for the pipeline. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | postProjectCreation | Called once, right after `postSynthesize()`, only when the project is created for the first time. | | postSynthesize | Called after synthesis. | | preSynthesize | Called before synthesis. | | projectCreation | Called once, right after `synthesize()`, only when the project is created for the first time. | | synthesize | Synthesizes files to the project output directory. | | engineType | *No description.* | | generateVersioningAppCode | Generate CDK application code for versioning. | | generateVersioningImports | Generate versioning imports for CDK application. | | generateVersioningUtilities | Generate versioning utility functions for CDK application. | | createIndependentDeployment | Creates a job to deploy the CDK application to AWS. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `postProjectCreation` ```typescript public postProjectCreation(initProject: InitProject): void ``` Called once, right after `postSynthesize()`, only when the project is created for the first time. It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`). It is also skipped when post-synthesis steps are disabled, e.g. `--no-post` or `PROJEN_DISABLE_POST`. Use it for one-off setup that can be turned off by the user, like running a task to give the user immediate feedback on their new project. Order across components is not guaranteed. ###### `initProject`^Required - *Type:* projen.InitProject Details about how the project was created, e.g. its type and the original CLI args. --- ##### `postSynthesize` ```typescript public postSynthesize(): void ``` Called after synthesis. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before synthesis. ##### `projectCreation` ```typescript public projectCreation(initProject: InitProject): void ``` Called once, right after `synthesize()`, only when the project is created for the first time. It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`). Use it for deterministic, one-off file generation. Order across components is not guaranteed. ###### `initProject`^Required - *Type:* projen.InitProject Details about how the project was created, e.g. its type and the original CLI args. --- ##### `synthesize` ```typescript public synthesize(): void ``` Synthesizes files to the project output directory. ##### `engineType` ```typescript public engineType(): PipelineEngine ``` ##### `generateVersioningAppCode` ```typescript public generateVersioningAppCode(config: VersioningConfig): string ``` Generate CDK application code for versioning. ###### `config`^Required - *Type:* VersioningConfig --- ##### `generateVersioningImports` ```typescript public generateVersioningImports(): string ``` Generate versioning imports for CDK application. ##### `generateVersioningUtilities` ```typescript public generateVersioningUtilities(): string ``` Generate versioning utility functions for CDK application. ##### `createIndependentDeployment` ```typescript public createIndependentDeployment(stage: IndependentStage): void ``` Creates a job to deploy the CDK application to AWS. ###### `stage`^Required - *Type:* IndependentStage The independent stage to create. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isComponent | Test whether the given construct is a component. | --- ##### `isConstruct` ```typescript import { GitlabCDKPipeline } from 'projen-pipelines' GitlabCDKPipeline.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` ```typescript import { GitlabCDKPipeline } from 'projen-pipelines' GitlabCDKPipeline.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.* | | branchName | string | *No description.* | | stackPrefix | string | *No description.* | | config | projen.gitlab.GitlabConfiguration | GitLab CI/CD configuration object. | | jobImage | string | The Docker image used for pipeline jobs. | | needsVersionedArtifacts | boolean | Indicates if versioned artifacts are required. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `project`^Required ```typescript public readonly project: Project; ``` - *Type:* projen.Project --- ##### `branchName`^Required ```typescript public readonly branchName: string; ``` - *Type:* string --- ##### `stackPrefix`^Required ```typescript public readonly stackPrefix: string; ``` - *Type:* string --- ##### `config`^Required ```typescript public readonly config: GitlabConfiguration; ``` - *Type:* projen.gitlab.GitlabConfiguration GitLab CI/CD configuration object. --- ##### `jobImage`^Required ```typescript public readonly jobImage: string; ``` - *Type:* string The Docker image used for pipeline jobs. Defaults to a specified image or a default value. --- ##### `needsVersionedArtifacts`^Required ```typescript public readonly needsVersionedArtifacts: boolean; ``` - *Type:* boolean Indicates if versioned artifacts are required. Currently set to false --- ### GitLabDriftDetectionWorkflow #### Initializers ```typescript import { GitLabDriftDetectionWorkflow } from 'projen-pipelines' new GitLabDriftDetectionWorkflow(project: Project, options: GitLabDriftDetectionWorkflowOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | projen.Project | *No description.* | | options | GitLabDriftDetectionWorkflowOptions | *No description.* | --- ##### `project`^Required - *Type:* projen.Project --- ##### `options`^Required - *Type:* GitLabDriftDetectionWorkflowOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | postProjectCreation | Called once, right after `postSynthesize()`, only when the project is created for the first time. | | postSynthesize | Called after synthesis. | | preSynthesize | Called before synthesis. | | projectCreation | Called once, right after `synthesize()`, only when the project is created for the first time. | | synthesize | Synthesizes files to the project output directory. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `postProjectCreation` ```typescript public postProjectCreation(initProject: InitProject): void ``` Called once, right after `postSynthesize()`, only when the project is created for the first time. It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`). It is also skipped when post-synthesis steps are disabled, e.g. `--no-post` or `PROJEN_DISABLE_POST`. Use it for one-off setup that can be turned off by the user, like running a task to give the user immediate feedback on their new project. Order across components is not guaranteed. ###### `initProject`^Required - *Type:* projen.InitProject Details about how the project was created, e.g. its type and the original CLI args. --- ##### `postSynthesize` ```typescript public postSynthesize(): void ``` Called after synthesis. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before synthesis. ##### `projectCreation` ```typescript public projectCreation(initProject: InitProject): void ``` Called once, right after `synthesize()`, only when the project is created for the first time. It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`). Use it for deterministic, one-off file generation. Order across components is not guaranteed. ###### `initProject`^Required - *Type:* projen.InitProject Details about how the project was created, e.g. its type and the original CLI args. --- ##### `synthesize` ```typescript public synthesize(): void ``` Synthesizes files to the project output directory. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isComponent | Test whether the given construct is a component. | --- ##### `isConstruct` ```typescript import { GitLabDriftDetectionWorkflow } from 'projen-pipelines' GitLabDriftDetectionWorkflow.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` ```typescript import { GitLabDriftDetectionWorkflow } from 'projen-pipelines' GitLabDriftDetectionWorkflow.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.* | | name | string | *No description.* | | schedule | string | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `project`^Required ```typescript public readonly project: Project; ``` - *Type:* projen.Project --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `schedule`^Required ```typescript public readonly schedule: string; ``` - *Type:* string --- ## Structs ### AmplifyDeployStepConfig Configuration for an AWS Amplify deployment step. #### Initializer ```typescript import { AmplifyDeployStepConfig } from 'projen-pipelines' const amplifyDeployStepConfig: AmplifyDeployStepConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | artifactFile | string | The artifact file to deploy (zip file containing the build). | | appId | string | The Amplify app ID (static value). | | appIdCommand | string | Command to retrieve the Amplify app ID dynamically. | | branchName | string | The branch name to deploy to (defaults to 'main'). | | environment | string | Environment name. | | region | string | The AWS region (defaults to 'eu-central-1'). | --- ##### `artifactFile`^Required ```typescript public readonly artifactFile: string; ``` - *Type:* string The artifact file to deploy (zip file containing the build). --- ##### `appId`^Optional ```typescript public readonly appId: string; ``` - *Type:* string The Amplify app ID (static value). --- ##### `appIdCommand`^Optional ```typescript public readonly appIdCommand: string; ``` - *Type:* string Command to retrieve the Amplify app ID dynamically. --- ##### `branchName`^Optional ```typescript public readonly branchName: string; ``` - *Type:* string The branch name to deploy to (defaults to 'main'). --- ##### `environment`^Optional ```typescript public readonly environment: string; ``` - *Type:* string Environment name. --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string The AWS region (defaults to 'eu-central-1'). --- ### ApproverMapping #### Initializer ```typescript import { ApproverMapping } from 'projen-pipelines' const approverMapping: ApproverMapping = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | approvers | string[] | *No description.* | | author | string | *No description.* | --- ##### `approvers`^Required ```typescript public readonly approvers: string[]; ``` - *Type:* string[] --- ##### `author`^Required ```typescript public readonly author: string; ``` - *Type:* string --- ### AssignApproverOptions #### Initializer ```typescript import { AssignApproverOptions } from 'projen-pipelines' const assignApproverOptions: AssignApproverOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | approverMapping | ApproverMapping[] | The mapping of authors to approvers. | | defaultApprovers | string[] | The GitHub token to use for the API calls. | --- ##### `approverMapping`^Required ```typescript public readonly approverMapping: ApproverMapping[]; ``` - *Type:* ApproverMapping[] The mapping of authors to approvers. --- ##### `defaultApprovers`^Required ```typescript public readonly defaultApprovers: string[]; ``` - *Type:* string[] The GitHub token to use for the API calls. --- ### AwsAssumeRoleStepConfig Configuration for an AWS AssumeRoleStep. #### Initializer ```typescript import { AwsAssumeRoleStepConfig } from 'projen-pipelines' const awsAssumeRoleStepConfig: AwsAssumeRoleStepConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | roleArn | string | The ARN of the role to assume. | | jumpRoleArn | string | The ARN of the jump role to use for role chaining. | | region | string | The AWS region that should be set. | | sessionName | string | An identifier for the assumed role session. | --- ##### `roleArn`^Required ```typescript public readonly roleArn: string; ``` - *Type:* string The ARN of the role to assume. --- ##### `jumpRoleArn`^Optional ```typescript public readonly jumpRoleArn: string; ``` - *Type:* string The ARN of the jump role to use for role chaining. --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string The AWS region that should be set. --- ##### `sessionName`^Optional ```typescript public readonly sessionName: string; ``` - *Type:* string An identifier for the assumed role session. --- ### BashCDKPipelineOptions #### Initializer ```typescript import { BashCDKPipelineOptions } from 'projen-pipelines' const bashCDKPipelineOptions: BashCDKPipelineOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | iamRoleArns | IamRoleConfig | IAM config. | | stages | DeploymentStage[] | This field specifies a list of stages that should be deployed using a CI/CD pipeline. | | branchName | string | the name of the branch to deploy from. | | deploySubStacks | boolean | If set to true all CDK actions will also include /* to deploy/diff/destroy sub stacks of the main stack. | | featureStages | StageOptions | This specifies details for feature stages. | | independentStages | IndependentStage[] | This specifies details for independent stages. | | paths | string[] | File path patterns that should trigger the pipeline when changed. | | personalStage | StageOptions | This specifies details for a personal stage. | | pipelineName | string | A unique name for this pipeline, used as a prefix for workflow files, concurrency groups, and artifact names to prevent collisions in monorepos. | | pkgNamespace | string | This field determines the NPM namespace to be used when packaging CDK cloud assemblies. | | postSynthCommands | string[] | *No description.* | | postSynthSteps | PipelineStep[] | *No description.* | | preBuildCommand | string | A command to run before the build step, executed from the repository root. | | preInstallCommands | string[] | *No description.* | | preInstallSteps | PipelineStep[] | *No description.* | | preSynthCommands | string[] | *No description.* | | preSynthSteps | PipelineStep[] | *No description.* | | stackPrefix | string | This field is used to define a prefix for the AWS Stack resources created during the pipeline's operation. | | versioning | VersioningConfig | Versioning configuration. | | workingDirectory | string | The working directory for the pipeline relative to the repository root. | --- ##### `iamRoleArns`^Required ```typescript public readonly iamRoleArns: IamRoleConfig; ``` - *Type:* IamRoleConfig IAM config. --- ##### `stages`^Required ```typescript public readonly stages: DeploymentStage[]; ``` - *Type:* DeploymentStage[] This field specifies a list of stages that should be deployed using a CI/CD pipeline. --- ##### `branchName`^Optional ```typescript public readonly branchName: string; ``` - *Type:* string - *Default:* main the name of the branch to deploy from. --- ##### `deploySubStacks`^Optional ```typescript public readonly deploySubStacks: boolean; ``` - *Type:* boolean - *Default:* false If set to true all CDK actions will also include /* to deploy/diff/destroy sub stacks of the main stack. You can use this to deploy CDk applications containing multiple stacks. --- ##### `featureStages`^Optional ```typescript public readonly featureStages: StageOptions; ``` - *Type:* StageOptions This specifies details for feature stages. --- ##### `independentStages`^Optional ```typescript public readonly independentStages: IndependentStage[]; ``` - *Type:* IndependentStage[] This specifies details for independent stages. --- ##### `paths`^Optional ```typescript public readonly paths: string[]; ``` - *Type:* string[] - *Default:* all paths trigger the pipeline File path patterns that should trigger the pipeline when changed. This is useful for monorepos where you only want to run the pipeline when files in a specific subproject are modified. For GitHub, these are used as `on.push.paths` and `on.pull_request.paths` filters. For GitLab, these are used as `only.changes` filters. --- *Example* ```typescript ['packages/my-app/**', 'shared-libs/**'] ``` ##### `personalStage`^Optional ```typescript public readonly personalStage: StageOptions; ``` - *Type:* StageOptions This specifies details for a personal stage. --- ##### `pipelineName`^Optional ```typescript public readonly pipelineName: string; ``` - *Type:* string - *Default:* the project name if the project has a parent (monorepo subproject), otherwise no prefix A unique name for this pipeline, used as a prefix for workflow files, concurrency groups, and artifact names to prevent collisions in monorepos. --- ##### `pkgNamespace`^Optional ```typescript public readonly pkgNamespace: string; ``` - *Type:* string - *Default:* This field determines the NPM namespace to be used when packaging CDK cloud assemblies. A namespace helps group related resources together, providing better organization and ease of management. This is only needed if you need to version and upload the cloud assembly to a package repository. --- ##### `postSynthCommands`^Optional ```typescript public readonly postSynthCommands: string[]; ``` - *Type:* string[] --- ##### `postSynthSteps`^Optional ```typescript public readonly postSynthSteps: PipelineStep[]; ``` - *Type:* PipelineStep[] --- ##### `preBuildCommand`^Optional ```typescript public readonly preBuildCommand: string; ``` - *Type:* string - *Default:* no pre-build command A command to run before the build step, executed from the repository root. When a workingDirectory is set (monorepo subproject), the command is automatically wrapped to execute from the repository root regardless of the job's working directory setting. For pnpm workspaces: `pnpm -r --filter ^... run build` For npm workspaces: `npm run build --workspaces --if-present` For yarn workspaces: `yarn workspaces foreach -Rt run build` --- ##### `preInstallCommands`^Optional ```typescript public readonly preInstallCommands: string[]; ``` - *Type:* string[] --- ##### `preInstallSteps`^Optional ```typescript public readonly preInstallSteps: PipelineStep[]; ``` - *Type:* PipelineStep[] --- ##### `preSynthCommands`^Optional ```typescript public readonly preSynthCommands: string[]; ``` - *Type:* string[] --- ##### `preSynthSteps`^Optional ```typescript public readonly preSynthSteps: PipelineStep[]; ``` - *Type:* PipelineStep[] --- ##### `stackPrefix`^Optional ```typescript public readonly stackPrefix: string; ``` - *Type:* string - *Default:* project name This field is used to define a prefix for the AWS Stack resources created during the pipeline's operation. --- ##### `versioning`^Optional ```typescript public readonly versioning: VersioningConfig; ``` - *Type:* VersioningConfig Versioning configuration. --- ##### `workingDirectory`^Optional ```typescript public readonly workingDirectory: string; ``` - *Type:* string - *Default:* automatically computed from the project's position in the monorepo (empty string for root projects) The working directory for the pipeline relative to the repository root. This is automatically computed for subprojects but can be explicitly set. When set, CI jobs will run commands in this directory, and artifact paths will be prefixed accordingly. --- ### BashDriftDetectionWorkflowOptions #### Initializer ```typescript import { BashDriftDetectionWorkflowOptions } from 'projen-pipelines' const bashDriftDetectionWorkflowOptions: BashDriftDetectionWorkflowOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | stages | DriftDetectionStageOptions[] | Drift detection configurations for different environments. | | name | string | Name of the workflow. | | pipelineName | string | A unique name for this pipeline, used as a prefix for workflow files and artifact names to prevent collisions in monorepos. | | preInstallSteps | PipelineStep[] | Additional steps to execute before installing dependencies. These steps are executed before the package manager setup and install command. | | schedule | string | Cron schedule for drift detection. | | scriptPath | string | Path to the output script. | --- ##### `stages`^Required ```typescript public readonly stages: DriftDetectionStageOptions[]; ``` - *Type:* DriftDetectionStageOptions[] Drift detection configurations for different environments. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string - *Default:* "drift-detection" Name of the workflow. --- ##### `pipelineName`^Optional ```typescript public readonly pipelineName: string; ``` - *Type:* string - *Default:* no prefix A unique name for this pipeline, used as a prefix for workflow files and artifact names to prevent collisions in monorepos. --- ##### `preInstallSteps`^Optional ```typescript public readonly preInstallSteps: PipelineStep[]; ``` - *Type:* PipelineStep[] - *Default:* no additional pre-install steps Additional steps to execute before installing dependencies. These steps are executed before the package manager setup and install command. Note: Package manager setup (e.g., PnpmSetupStep for pnpm or CorepackSetupStep for Yarn Berry) is automatically detected from the project and always included. Use this option for any additional pre-install steps you need. --- ##### `schedule`^Optional ```typescript public readonly schedule: string; ``` - *Type:* string - *Default:* "0 0 * * *" (daily at midnight) Cron schedule for drift detection. --- ##### `scriptPath`^Optional ```typescript public readonly scriptPath: string; ``` - *Type:* string - *Default:* "drift-detection.sh" Path to the output script. --- ### BashStepConfig Configuration interface for a bash script step. #### Initializer ```typescript import { BashStepConfig } from 'projen-pipelines' const bashStepConfig: BashStepConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | commands | string[] | Shell commands to execute. | --- ##### `commands`^Required ```typescript public readonly commands: string[]; ``` - *Type:* string[] Shell commands to execute. --- ### BuildNumberConfig #### Initializer ```typescript import { BuildNumberConfig } from 'projen-pipelines' const buildNumberConfig: BuildNumberConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | commitCount | CommitCountConfig | *No description.* | | prefix | string | *No description.* | --- ##### `commitCount`^Optional ```typescript public readonly commitCount: CommitCountConfig; ``` - *Type:* CommitCountConfig --- ##### `prefix`^Optional ```typescript public readonly prefix: string; ``` - *Type:* string --- ### CdkOutputsSummaryStepOptions Options for the CDK outputs summary step. #### Initializer ```typescript import { CdkOutputsSummaryStepOptions } from 'projen-pipelines' const cdkOutputsSummaryStepOptions: CdkOutputsSummaryStepOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | stageName | string | The stage name used to identify the outputs file. | --- ##### `stageName`^Required ```typescript public readonly stageName: string; ``` - *Type:* string The stage name used to identify the outputs file. --- ### CDKPipelineOptions The CDKPipelineOptions interface is designed to provide configuration options for a CDK (Cloud Development Kit) pipeline. It allows the definition of settings such as the stack prefix and package namespace to be used in the AWS stack, along with the environments configuration to be used. #### Initializer ```typescript import { CDKPipelineOptions } from 'projen-pipelines' const cDKPipelineOptions: CDKPipelineOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | iamRoleArns | IamRoleConfig | IAM config. | | stages | DeploymentStage[] | This field specifies a list of stages that should be deployed using a CI/CD pipeline. | | branchName | string | the name of the branch to deploy from. | | deploySubStacks | boolean | If set to true all CDK actions will also include /* to deploy/diff/destroy sub stacks of the main stack. | | featureStages | StageOptions | This specifies details for feature stages. | | independentStages | IndependentStage[] | This specifies details for independent stages. | | paths | string[] | File path patterns that should trigger the pipeline when changed. | | personalStage | StageOptions | This specifies details for a personal stage. | | pipelineName | string | A unique name for this pipeline, used as a prefix for workflow files, concurrency groups, and artifact names to prevent collisions in monorepos. | | pkgNamespace | string | This field determines the NPM namespace to be used when packaging CDK cloud assemblies. | | postSynthCommands | string[] | *No description.* | | postSynthSteps | PipelineStep[] | *No description.* | | preBuildCommand | string | A command to run before the build step, executed from the repository root. | | preInstallCommands | string[] | *No description.* | | preInstallSteps | PipelineStep[] | *No description.* | | preSynthCommands | string[] | *No description.* | | preSynthSteps | PipelineStep[] | *No description.* | | stackPrefix | string | This field is used to define a prefix for the AWS Stack resources created during the pipeline's operation. | | versioning | VersioningConfig | Versioning configuration. | | workingDirectory | string | The working directory for the pipeline relative to the repository root. | --- ##### `iamRoleArns`^Required ```typescript public readonly iamRoleArns: IamRoleConfig; ``` - *Type:* IamRoleConfig IAM config. --- ##### `stages`^Required ```typescript public readonly stages: DeploymentStage[]; ``` - *Type:* DeploymentStage[] This field specifies a list of stages that should be deployed using a CI/CD pipeline. --- ##### `branchName`^Optional ```typescript public readonly branchName: string; ``` - *Type:* string - *Default:* main the name of the branch to deploy from. --- ##### `deploySubStacks`^Optional ```typescript public readonly deploySubStacks: boolean; ``` - *Type:* boolean - *Default:* false If set to true all CDK actions will also include /* to deploy/diff/destroy sub stacks of the main stack. You can use this to deploy CDk applications containing multiple stacks. --- ##### `featureStages`^Optional ```typescript public readonly featureStages: StageOptions; ``` - *Type:* StageOptions This specifies details for feature stages. --- ##### `independentStages`^Optional ```typescript public readonly independentStages: IndependentStage[]; ``` - *Type:* IndependentStage[] This specifies details for independent stages. --- ##### `paths`^Optional ```typescript public readonly paths: string[]; ``` - *Type:* string[] - *Default:* all paths trigger the pipeline File path patterns that should trigger the pipeline when changed. This is useful for monorepos where you only want to run the pipeline when files in a specific subproject are modified. For GitHub, these are used as `on.push.paths` and `on.pull_request.paths` filters. For GitLab, these are used as `only.changes` filters. --- *Example* ```typescript ['packages/my-app/**', 'shared-libs/**'] ``` ##### `personalStage`^Optional ```typescript public readonly personalStage: StageOptions; ``` - *Type:* StageOptions This specifies details for a personal stage. --- ##### `pipelineName`^Optional ```typescript public readonly pipelineName: string; ``` - *Type:* string - *Default:* the project name if the project has a parent (monorepo subproject), otherwise no prefix A unique name for this pipeline, used as a prefix for workflow files, concurrency groups, and artifact names to prevent collisions in monorepos. --- ##### `pkgNamespace`^Optional ```typescript public readonly pkgNamespace: string; ``` - *Type:* string - *Default:* This field determines the NPM namespace to be used when packaging CDK cloud assemblies. A namespace helps group related resources together, providing better organization and ease of management. This is only needed if you need to version and upload the cloud assembly to a package repository. --- ##### `postSynthCommands`^Optional ```typescript public readonly postSynthCommands: string[]; ``` - *Type:* string[] --- ##### `postSynthSteps`^Optional ```typescript public readonly postSynthSteps: PipelineStep[]; ``` - *Type:* PipelineStep[] --- ##### `preBuildCommand`^Optional ```typescript public readonly preBuildCommand: string; ``` - *Type:* string - *Default:* no pre-build command A command to run before the build step, executed from the repository root. When a workingDirectory is set (monorepo subproject), the command is automatically wrapped to execute from the repository root regardless of the job's working directory setting. For pnpm workspaces: `pnpm -r --filter ^... run build` For npm workspaces: `npm run build --workspaces --if-present` For yarn workspaces: `yarn workspaces foreach -Rt run build` --- ##### `preInstallCommands`^Optional ```typescript public readonly preInstallCommands: string[]; ``` - *Type:* string[] --- ##### `preInstallSteps`^Optional ```typescript public readonly preInstallSteps: PipelineStep[]; ``` - *Type:* PipelineStep[] --- ##### `preSynthCommands`^Optional ```typescript public readonly preSynthCommands: string[]; ``` - *Type:* string[] --- ##### `preSynthSteps`^Optional ```typescript public readonly preSynthSteps: PipelineStep[]; ``` - *Type:* PipelineStep[] --- ##### `stackPrefix`^Optional ```typescript public readonly stackPrefix: string; ``` - *Type:* string - *Default:* project name This field is used to define a prefix for the AWS Stack resources created during the pipeline's operation. --- ##### `versioning`^Optional ```typescript public readonly versioning: VersioningConfig; ``` - *Type:* VersioningConfig Versioning configuration. --- ##### `workingDirectory`^Optional ```typescript public readonly workingDirectory: string; ``` - *Type:* string - *Default:* automatically computed from the project's position in the monorepo (empty string for root projects) The working directory for the pipeline relative to the repository root. This is automatically computed for subprojects but can be explicitly set. When set, CI jobs will run commands in this directory, and artifact paths will be prefixed accordingly. --- ### CloudFormationOnlyOptions #### Initializer ```typescript import { CloudFormationOnlyOptions } from 'projen-pipelines' const cloudFormationOnlyOptions: CloudFormationOnlyOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | exportName | string | *No description.* | | format | string | *No description.* | | stackOutputName | string | *No description.* | --- ##### `exportName`^Optional ```typescript public readonly exportName: string; ``` - *Type:* string --- ##### `format`^Optional ```typescript public readonly format: string; ``` - *Type:* string --- ##### `stackOutputName`^Optional ```typescript public readonly stackOutputName: string; ``` - *Type:* string --- ### CloudFormationOutputConfig #### Initializer ```typescript import { CloudFormationOutputConfig } from 'projen-pipelines' const cloudFormationOutputConfig: CloudFormationOutputConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | enabled | boolean | *No description.* | | exportName | string | *No description.* | --- ##### `enabled`^Required ```typescript public readonly enabled: boolean; ``` - *Type:* boolean --- ##### `exportName`^Optional ```typescript public readonly exportName: string; ``` - *Type:* string --- ### CodeArtifactLoginStepOptions Options for the CodeArtifactLoginStep. #### Initializer ```typescript import { CodeArtifactLoginStepOptions } from 'projen-pipelines' const codeArtifactLoginStepOptions: CodeArtifactLoginStepOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | domainName | string | *No description.* | | ownerAccount | string | *No description.* | | region | string | *No description.* | | role | string | *No description.* | | envVariableName | string | The environment variable name to set. | --- ##### `domainName`^Required ```typescript public readonly domainName: string; ``` - *Type:* string --- ##### `ownerAccount`^Required ```typescript public readonly ownerAccount: string; ``` - *Type:* string --- ##### `region`^Required ```typescript public readonly region: string; ``` - *Type:* string --- ##### `role`^Required ```typescript public readonly role: string; ``` - *Type:* string --- ##### `envVariableName`^Optional ```typescript public readonly envVariableName: string; ``` - *Type:* string - *Default:* 'CODEARTIFACT_AUTH_TOKEN' The environment variable name to set. --- ### CommitCountConfig #### Initializer ```typescript import { CommitCountConfig } from 'projen-pipelines' const commitCountConfig: CommitCountConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | countFrom | string | Count from: 'all' \| 'branch' \| 'since-tag'. | | includeBranch | boolean | Include branch name. | | padding | number | Padding for count. | | resetOnMajor | boolean | Reset on major version. | --- ##### `countFrom`^Optional ```typescript public readonly countFrom: string; ``` - *Type:* string Count from: 'all' | 'branch' | 'since-tag'. --- ##### `includeBranch`^Optional ```typescript public readonly includeBranch: boolean; ``` - *Type:* boolean Include branch name. --- ##### `padding`^Optional ```typescript public readonly padding: number; ``` - *Type:* number Padding for count. --- ##### `resetOnMajor`^Optional ```typescript public readonly resetOnMajor: boolean; ``` - *Type:* boolean Reset on major version. --- ### ComputationContext Context for version computation. #### Initializer ```typescript import { ComputationContext } from 'projen-pipelines' const computationContext: ComputationContext = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | deployedBy | string | *No description.* | | environment | string | *No description.* | | gitInfo | GitInfo | *No description.* | | buildNumber | string | *No description.* | | pipelineVersion | string | *No description.* | | repository | string | *No description.* | --- ##### `deployedBy`^Required ```typescript public readonly deployedBy: string; ``` - *Type:* string --- ##### `environment`^Required ```typescript public readonly environment: string; ``` - *Type:* string --- ##### `gitInfo`^Required ```typescript public readonly gitInfo: GitInfo; ``` - *Type:* GitInfo --- ##### `buildNumber`^Optional ```typescript public readonly buildNumber: string; ``` - *Type:* string --- ##### `pipelineVersion`^Optional ```typescript public readonly pipelineVersion: string; ``` - *Type:* string --- ##### `repository`^Optional ```typescript public readonly repository: string; ``` - *Type:* string --- ### CustomVersioningConfig #### Initializer ```typescript import { CustomVersioningConfig } from 'projen-pipelines' const customVersioningConfig: CustomVersioningConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | outputs | VersioningOutputConfig | *No description.* | | strategy | IVersioningStrategy | *No description.* | | enabled | boolean | *No description.* | | stageOverrides | {[ key: string ]: VersioningConfig} | *No description.* | --- ##### `outputs`^Required ```typescript public readonly outputs: VersioningOutputConfig; ``` - *Type:* VersioningOutputConfig --- ##### `strategy`^Required ```typescript public readonly strategy: IVersioningStrategy; ``` - *Type:* IVersioningStrategy --- ##### `enabled`^Optional ```typescript public readonly enabled: boolean; ``` - *Type:* boolean --- ##### `stageOverrides`^Optional ```typescript public readonly stageOverrides: {[ key: string ]: VersioningConfig}; ``` - *Type:* {[ key: string ]: VersioningConfig} --- ### DeploymentInfoInput #### Initializer ```typescript import { DeploymentInfoInput } from 'projen-pipelines' const deploymentInfoInput: DeploymentInfoInput = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | environment | string | *No description.* | | buildNumber | string | *No description.* | | deployedBy | string | *No description.* | --- ##### `environment`^Required ```typescript public readonly environment: string; ``` - *Type:* string --- ##### `buildNumber`^Optional ```typescript public readonly buildNumber: string; ``` - *Type:* string --- ##### `deployedBy`^Optional ```typescript public readonly deployedBy: string; ``` - *Type:* string --- ### DeploymentStage Options for stages that are part of the pipeline. #### Initializer ```typescript import { DeploymentStage } from 'projen-pipelines' const deploymentStage: DeploymentStage = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | env | Environment | *No description.* | | name | string | *No description.* | | diffType | CdkDiffType | *No description.* | | githubEnvironment | string | The name of the GitHub environment to use for this stage. | | postDeploySteps | PipelineStep[] | *No description.* | | postDiffSteps | PipelineStep[] | *No description.* | | watchable | boolean | *No description.* | | manualApproval | boolean | *No description.* | --- ##### `env`^Required ```typescript public readonly env: Environment; ``` - *Type:* Environment --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `diffType`^Optional ```typescript public readonly diffType: CdkDiffType; ``` - *Type:* CdkDiffType --- ##### `githubEnvironment`^Optional ```typescript public readonly githubEnvironment: string; ``` - *Type:* string - *Default:* the stage name The name of the GitHub environment to use for this stage. If not specified, the stage name will be used as the GitHub environment name. --- ##### `postDeploySteps`^Optional ```typescript public readonly postDeploySteps: PipelineStep[]; ``` - *Type:* PipelineStep[] --- ##### `postDiffSteps`^Optional ```typescript public readonly postDiffSteps: PipelineStep[]; ``` - *Type:* PipelineStep[] --- ##### `watchable`^Optional ```typescript public readonly watchable: boolean; ``` - *Type:* boolean --- ##### `manualApproval`^Optional ```typescript public readonly manualApproval: boolean; ``` - *Type:* boolean --- ### DownloadArtifactStepConfig #### Initializer ```typescript import { DownloadArtifactStepConfig } from 'projen-pipelines' const downloadArtifactStepConfig: DownloadArtifactStepConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | *No description.* | | path | string | *No description.* | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `path`^Required ```typescript public readonly path: string; ``` - *Type:* string --- ### DriftDetectionStageOptions #### Initializer ```typescript import { DriftDetectionStageOptions } from 'projen-pipelines' const driftDetectionStageOptions: DriftDetectionStageOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Name of the stage. | | region | string | AWS region for this stage. | | environment | {[ key: string ]: string} | Environment variables for this stage. | | failOnDrift | boolean | Whether to fail if drift is detected. | | jumpRoleArn | string | Jump role to assume before the main role. | | roleArn | string | Role to assume for drift detection. | | stackNames | string[] | Stack names to check in this stage. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `region`^Required ```typescript public readonly region: string; ``` - *Type:* string AWS region for this stage. --- ##### `environment`^Optional ```typescript public readonly environment: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Environment variables for this stage. --- ##### `failOnDrift`^Optional ```typescript public readonly failOnDrift: boolean; ``` - *Type:* boolean - *Default:* true Whether to fail if drift is detected. --- ##### `jumpRoleArn`^Optional ```typescript public readonly jumpRoleArn: string; ``` - *Type:* string Jump role to assume before the main role. --- ##### `roleArn`^Optional ```typescript public readonly roleArn: string; ``` - *Type:* string Role to assume for drift detection. --- ##### `stackNames`^Optional ```typescript public readonly stackNames: string[]; ``` - *Type:* string[] Stack names to check in this stage. --- ### DriftDetectionStepProps #### Initializer ```typescript import { DriftDetectionStepProps } from 'projen-pipelines' const driftDetectionStepProps: DriftDetectionStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Name of the stage. | | region | string | AWS region for this stage. | | environment | {[ key: string ]: string} | Environment variables for this stage. | | failOnDrift | boolean | Whether to fail if drift is detected. | | jumpRoleArn | string | Jump role to assume before the main role. | | roleArn | string | Role to assume for drift detection. | | stackNames | string[] | Stack names to check in this stage. | | timeout | number | Timeout in minutes for drift detection. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `region`^Required ```typescript public readonly region: string; ``` - *Type:* string AWS region for this stage. --- ##### `environment`^Optional ```typescript public readonly environment: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Environment variables for this stage. --- ##### `failOnDrift`^Optional ```typescript public readonly failOnDrift: boolean; ``` - *Type:* boolean - *Default:* true Whether to fail if drift is detected. --- ##### `jumpRoleArn`^Optional ```typescript public readonly jumpRoleArn: string; ``` - *Type:* string Jump role to assume before the main role. --- ##### `roleArn`^Optional ```typescript public readonly roleArn: string; ``` - *Type:* string Role to assume for drift detection. --- ##### `stackNames`^Optional ```typescript public readonly stackNames: string[]; ``` - *Type:* string[] Stack names to check in this stage. --- ##### `timeout`^Optional ```typescript public readonly timeout: number; ``` - *Type:* number - *Default:* 30 Timeout in minutes for drift detection. --- ### DriftDetectionWorkflowOptions #### Initializer ```typescript import { DriftDetectionWorkflowOptions } from 'projen-pipelines' const driftDetectionWorkflowOptions: DriftDetectionWorkflowOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | stages | DriftDetectionStageOptions[] | Drift detection configurations for different environments. | | name | string | Name of the workflow. | | pipelineName | string | A unique name for this pipeline, used as a prefix for workflow files and artifact names to prevent collisions in monorepos. | | preInstallSteps | PipelineStep[] | Additional steps to execute before installing dependencies. These steps are executed before the package manager setup and install command. | | schedule | string | Cron schedule for drift detection. | --- ##### `stages`^Required ```typescript public readonly stages: DriftDetectionStageOptions[]; ``` - *Type:* DriftDetectionStageOptions[] Drift detection configurations for different environments. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string - *Default:* "drift-detection" Name of the workflow. --- ##### `pipelineName`^Optional ```typescript public readonly pipelineName: string; ``` - *Type:* string - *Default:* no prefix A unique name for this pipeline, used as a prefix for workflow files and artifact names to prevent collisions in monorepos. --- ##### `preInstallSteps`^Optional ```typescript public readonly preInstallSteps: PipelineStep[]; ``` - *Type:* PipelineStep[] - *Default:* no additional pre-install steps Additional steps to execute before installing dependencies. These steps are executed before the package manager setup and install command. Note: Package manager setup (e.g., PnpmSetupStep for pnpm or CorepackSetupStep for Yarn Berry) is automatically detected from the project and always included. Use this option for any additional pre-install steps you need. --- ##### `schedule`^Optional ```typescript public readonly schedule: string; ``` - *Type:* string - *Default:* "0 0 * * *" (daily at midnight) Cron schedule for drift detection. --- ### DriftErrorHandler #### Initializer ```typescript import { DriftErrorHandler } from 'projen-pipelines' const driftErrorHandler: DriftErrorHandler = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | string | Action to take when pattern matches. | | pattern | string | Pattern to match stack names. | | message | string | Optional message to display. | --- ##### `action`^Required ```typescript public readonly action: string; ``` - *Type:* string Action to take when pattern matches. --- ##### `pattern`^Required ```typescript public readonly pattern: string; ``` - *Type:* string Pattern to match stack names. --- ##### `message`^Optional ```typescript public readonly message: string; ``` - *Type:* string Optional message to display. --- ### Environment The Environment interface is designed to hold AWS related information for a specific deployment environment within your infrastructure. Each environment requires a specific account and region for its resources. #### Initializer ```typescript import { Environment } from 'projen-pipelines' const environment: Environment = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | account | string | The AWS Account ID associated with the environment. | | region | string | The AWS Region for the environment. | --- ##### `account`^Required ```typescript public readonly account: string; ``` - *Type:* string The AWS Account ID associated with the environment. It's important because different services or features could have distinct permissions and settings in different accounts. --- ##### `region`^Required ```typescript public readonly region: string; ``` - *Type:* string The AWS Region for the environment. This determines where your resources are created and where your application will run. It can affect latency, availability, and pricing. --- ### GitHubAssignApproverOptions #### Initializer ```typescript import { GitHubAssignApproverOptions } from 'projen-pipelines' const gitHubAssignApproverOptions: GitHubAssignApproverOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | approverMapping | ApproverMapping[] | The mapping of authors to approvers. | | defaultApprovers | string[] | The GitHub token to use for the API calls. | | runnerTags | string[] | runner tags to use to select runners. | --- ##### `approverMapping`^Required ```typescript public readonly approverMapping: ApproverMapping[]; ``` - *Type:* ApproverMapping[] The mapping of authors to approvers. --- ##### `defaultApprovers`^Required ```typescript public readonly defaultApprovers: string[]; ``` - *Type:* string[] The GitHub token to use for the API calls. --- ##### `runnerTags`^Optional ```typescript public readonly runnerTags: string[]; ``` - *Type:* string[] - *Default:* ['ubuntu-latest'] runner tags to use to select runners. --- ### GithubCDKPipelineOptions Extension of the base CDKPipeline options including specific configurations for GitHub. #### Initializer ```typescript import { GithubCDKPipelineOptions } from 'projen-pipelines' const githubCDKPipelineOptions: GithubCDKPipelineOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | iamRoleArns | IamRoleConfig | IAM config. | | stages | DeploymentStage[] | This field specifies a list of stages that should be deployed using a CI/CD pipeline. | | branchName | string | the name of the branch to deploy from. | | deploySubStacks | boolean | If set to true all CDK actions will also include /* to deploy/diff/destroy sub stacks of the main stack. | | featureStages | StageOptions | This specifies details for feature stages. | | independentStages | IndependentStage[] | This specifies details for independent stages. | | paths | string[] | File path patterns that should trigger the pipeline when changed. | | personalStage | StageOptions | This specifies details for a personal stage. | | pipelineName | string | A unique name for this pipeline, used as a prefix for workflow files, concurrency groups, and artifact names to prevent collisions in monorepos. | | pkgNamespace | string | This field determines the NPM namespace to be used when packaging CDK cloud assemblies. | | postSynthCommands | string[] | *No description.* | | postSynthSteps | PipelineStep[] | *No description.* | | preBuildCommand | string | A command to run before the build step, executed from the repository root. | | preInstallCommands | string[] | *No description.* | | preInstallSteps | PipelineStep[] | *No description.* | | preSynthCommands | string[] | *No description.* | | preSynthSteps | PipelineStep[] | *No description.* | | stackPrefix | string | This field is used to define a prefix for the AWS Stack resources created during the pipeline's operation. | | versioning | VersioningConfig | Versioning configuration. | | workingDirectory | string | The working directory for the pipeline relative to the repository root. | | runnerTags | string[] | runner tags to use to select runners. | | useGithubEnvironments | boolean | whether to use GitHub environments for deployment stages. | | useGithubEnvironmentsForAssetUpload | boolean | whether to use GitHub environments for asset upload step Create separate, parallel jobs for asset upload since GitHub Environments require unique environment names per job. | | useGithubPackagesForAssembly | boolean | use GitHub Packages to store vesioned artifacts of cloud assembly; | --- ##### `iamRoleArns`^Required ```typescript public readonly iamRoleArns: IamRoleConfig; ``` - *Type:* IamRoleConfig IAM config. --- ##### `stages`^Required ```typescript public readonly stages: DeploymentStage[]; ``` - *Type:* DeploymentStage[] This field specifies a list of stages that should be deployed using a CI/CD pipeline. --- ##### `branchName`^Optional ```typescript public readonly branchName: string; ``` - *Type:* string - *Default:* main the name of the branch to deploy from. --- ##### `deploySubStacks`^Optional ```typescript public readonly deploySubStacks: boolean; ``` - *Type:* boolean - *Default:* false If set to true all CDK actions will also include /* to deploy/diff/destroy sub stacks of the main stack. You can use this to deploy CDk applications containing multiple stacks. --- ##### `featureStages`^Optional ```typescript public readonly featureStages: StageOptions; ``` - *Type:* StageOptions This specifies details for feature stages. --- ##### `independentStages`^Optional ```typescript public readonly independentStages: IndependentStage[]; ``` - *Type:* IndependentStage[] This specifies details for independent stages. --- ##### `paths`^Optional ```typescript public readonly paths: string[]; ``` - *Type:* string[] - *Default:* all paths trigger the pipeline File path patterns that should trigger the pipeline when changed. This is useful for monorepos where you only want to run the pipeline when files in a specific subproject are modified. For GitHub, these are used as `on.push.paths` and `on.pull_request.paths` filters. For GitLab, these are used as `only.changes` filters. --- *Example* ```typescript ['packages/my-app/**', 'shared-libs/**'] ``` ##### `personalStage`^Optional ```typescript public readonly personalStage: StageOptions; ``` - *Type:* StageOptions This specifies details for a personal stage. --- ##### `pipelineName`^Optional ```typescript public readonly pipelineName: string; ``` - *Type:* string - *Default:* the project name if the project has a parent (monorepo subproject), otherwise no prefix A unique name for this pipeline, used as a prefix for workflow files, concurrency groups, and artifact names to prevent collisions in monorepos. --- ##### `pkgNamespace`^Optional ```typescript public readonly pkgNamespace: string; ``` - *Type:* string - *Default:* This field determines the NPM namespace to be used when packaging CDK cloud assemblies. A namespace helps group related resources together, providing better organization and ease of management. This is only needed if you need to version and upload the cloud assembly to a package repository. --- ##### `postSynthCommands`^Optional ```typescript public readonly postSynthCommands: string[]; ``` - *Type:* string[] --- ##### `postSynthSteps`^Optional ```typescript public readonly postSynthSteps: PipelineStep[]; ``` - *Type:* PipelineStep[] --- ##### `preBuildCommand`^Optional ```typescript public readonly preBuildCommand: string; ``` - *Type:* string - *Default:* no pre-build command A command to run before the build step, executed from the repository root. When a workingDirectory is set (monorepo subproject), the command is automatically wrapped to execute from the repository root regardless of the job's working directory setting. For pnpm workspaces: `pnpm -r --filter ^... run build` For npm workspaces: `npm run build --workspaces --if-present` For yarn workspaces: `yarn workspaces foreach -Rt run build` --- ##### `preInstallCommands`^Optional ```typescript public readonly preInstallCommands: string[]; ``` - *Type:* string[] --- ##### `preInstallSteps`^Optional ```typescript public readonly preInstallSteps: PipelineStep[]; ``` - *Type:* PipelineStep[] --- ##### `preSynthCommands`^Optional ```typescript public readonly preSynthCommands: string[]; ``` - *Type:* string[] --- ##### `preSynthSteps`^Optional ```typescript public readonly preSynthSteps: PipelineStep[]; ``` - *Type:* PipelineStep[] --- ##### `stackPrefix`^Optional ```typescript public readonly stackPrefix: string; ``` - *Type:* string - *Default:* project name This field is used to define a prefix for the AWS Stack resources created during the pipeline's operation. --- ##### `versioning`^Optional ```typescript public readonly versioning: VersioningConfig; ``` - *Type:* VersioningConfig Versioning configuration. --- ##### `workingDirectory`^Optional ```typescript public readonly workingDirectory: string; ``` - *Type:* string - *Default:* automatically computed from the project's position in the monorepo (empty string for root projects) The working directory for the pipeline relative to the repository root. This is automatically computed for subprojects but can be explicitly set. When set, CI jobs will run commands in this directory, and artifact paths will be prefixed accordingly. --- ##### `runnerTags`^Optional ```typescript public readonly runnerTags: string[]; ``` - *Type:* string[] - *Default:* ['ubuntu-latest'] runner tags to use to select runners. --- ##### `useGithubEnvironments`^Optional ```typescript public readonly useGithubEnvironments: boolean; ``` - *Type:* boolean - *Default:* false whether to use GitHub environments for deployment stages. INFO: When using environments consider protection rules instead of using the manual option of projen-pipelines for stages --- ##### `useGithubEnvironmentsForAssetUpload`^Optional ```typescript public readonly useGithubEnvironmentsForAssetUpload: boolean; ``` - *Type:* boolean - *Default:* false whether to use GitHub environments for asset upload step Create separate, parallel jobs for asset upload since GitHub Environments require unique environment names per job. WARNING: this parameter requires rebuilding the container assets for each stage and they will not be the "same binary", so there is a (small) chance that it could produce different binaries per stage --- ##### `useGithubPackagesForAssembly`^Optional ```typescript public readonly useGithubPackagesForAssembly: boolean; ``` - *Type:* boolean use GitHub Packages to store vesioned artifacts of cloud assembly; also needed for manual approvals --- ### GitHubDriftDetectionWorkflowOptions #### Initializer ```typescript import { GitHubDriftDetectionWorkflowOptions } from 'projen-pipelines' const gitHubDriftDetectionWorkflowOptions: GitHubDriftDetectionWorkflowOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | stages | DriftDetectionStageOptions[] | Drift detection configurations for different environments. | | name | string | Name of the workflow. | | pipelineName | string | A unique name for this pipeline, used as a prefix for workflow files and artifact names to prevent collisions in monorepos. | | preInstallSteps | PipelineStep[] | Additional steps to execute before installing dependencies. These steps are executed before the package manager setup and install command. | | schedule | string | Cron schedule for drift detection. | | createIssues | boolean | Whether to create issues on drift detection. | | permissions | {[ key: string ]: string} | Additional permissions for GitHub workflow. | --- ##### `stages`^Required ```typescript public readonly stages: DriftDetectionStageOptions[]; ``` - *Type:* DriftDetectionStageOptions[] Drift detection configurations for different environments. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string - *Default:* "drift-detection" Name of the workflow. --- ##### `pipelineName`^Optional ```typescript public readonly pipelineName: string; ``` - *Type:* string - *Default:* no prefix A unique name for this pipeline, used as a prefix for workflow files and artifact names to prevent collisions in monorepos. --- ##### `preInstallSteps`^Optional ```typescript public readonly preInstallSteps: PipelineStep[]; ``` - *Type:* PipelineStep[] - *Default:* no additional pre-install steps Additional steps to execute before installing dependencies. These steps are executed before the package manager setup and install command. Note: Package manager setup (e.g., PnpmSetupStep for pnpm or CorepackSetupStep for Yarn Berry) is automatically detected from the project and always included. Use this option for any additional pre-install steps you need. --- ##### `schedule`^Optional ```typescript public readonly schedule: string; ``` - *Type:* string - *Default:* "0 0 * * *" (daily at midnight) Cron schedule for drift detection. --- ##### `createIssues`^Optional ```typescript public readonly createIssues: boolean; ``` - *Type:* boolean - *Default:* false Whether to create issues on drift detection. --- ##### `permissions`^Optional ```typescript public readonly permissions: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Additional permissions for GitHub workflow. --- ### GithubPackagesLoginStepOptions #### Initializer ```typescript import { GithubPackagesLoginStepOptions } from 'projen-pipelines' const githubPackagesLoginStepOptions: GithubPackagesLoginStepOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | write | boolean | Whether or not to grant the step write permissions to the registry. | --- ##### `write`^Optional ```typescript public readonly write: boolean; ``` - *Type:* boolean - *Default:* false Whether or not to grant the step write permissions to the registry. --- ### GithubStepConfig Configuration interface for a GitHub Actions step. #### Initializer ```typescript import { GithubStepConfig } from 'projen-pipelines' const githubStepConfig: GithubStepConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | env | {[ key: string ]: string} | Additional environment variables to set for this step. | | needs | string[] | Dependencies which need to be completed before this step. | | steps | projen.github.workflows.JobStep[] | Commands wrapped as GitHub Action job steps. | | permissions | projen.github.workflows.JobPermissions | Additional job permissions needed. | --- ##### `env`^Required ```typescript public readonly env: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Additional environment variables to set for this step. --- ##### `needs`^Required ```typescript public readonly needs: string[]; ``` - *Type:* string[] Dependencies which need to be completed before this step. --- ##### `steps`^Required ```typescript public readonly steps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] Commands wrapped as GitHub Action job steps. --- ##### `permissions`^Optional ```typescript public readonly permissions: JobPermissions; ``` - *Type:* projen.github.workflows.JobPermissions Additional job permissions needed. --- ### GitInfo Git information extracted from repository. #### Initializer ```typescript import { GitInfo } from 'projen-pipelines' const gitInfo: GitInfo = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | branch | string | *No description.* | | commitCount | number | *No description.* | | commitHash | string | *No description.* | | commitHashShort | string | *No description.* | | commitsSinceTag | number | *No description.* | | packageVersion | string | *No description.* | | tag | string | *No description.* | --- ##### `branch`^Required ```typescript public readonly branch: string; ``` - *Type:* string --- ##### `commitCount`^Required ```typescript public readonly commitCount: number; ``` - *Type:* number --- ##### `commitHash`^Required ```typescript public readonly commitHash: string; ``` - *Type:* string --- ##### `commitHashShort`^Required ```typescript public readonly commitHashShort: string; ``` - *Type:* string --- ##### `commitsSinceTag`^Optional ```typescript public readonly commitsSinceTag: number; ``` - *Type:* number --- ##### `packageVersion`^Optional ```typescript public readonly packageVersion: string; ``` - *Type:* string --- ##### `tag`^Optional ```typescript public readonly tag: string; ``` - *Type:* string --- ### GitInfoInput #### Initializer ```typescript import { GitInfoInput } from 'projen-pipelines' const gitInfoInput: GitInfoInput = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | branch | string | *No description.* | | commitCount | number | *No description.* | | commitHash | string | *No description.* | | commitsSinceTag | number | *No description.* | | tag | string | *No description.* | --- ##### `branch`^Required ```typescript public readonly branch: string; ``` - *Type:* string --- ##### `commitCount`^Required ```typescript public readonly commitCount: number; ``` - *Type:* number --- ##### `commitHash`^Required ```typescript public readonly commitHash: string; ``` - *Type:* string --- ##### `commitsSinceTag`^Optional ```typescript public readonly commitsSinceTag: number; ``` - *Type:* number --- ##### `tag`^Optional ```typescript public readonly tag: string; ``` - *Type:* string --- ### GitlabCDKPipelineOptions Options for configuring the GitLab CDK pipeline, extending the base CDK pipeline options. #### Initializer ```typescript import { GitlabCDKPipelineOptions } from 'projen-pipelines' const gitlabCDKPipelineOptions: GitlabCDKPipelineOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | iamRoleArns | IamRoleConfig | IAM config. | | stages | DeploymentStage[] | This field specifies a list of stages that should be deployed using a CI/CD pipeline. | | branchName | string | the name of the branch to deploy from. | | deploySubStacks | boolean | If set to true all CDK actions will also include /* to deploy/diff/destroy sub stacks of the main stack. | | featureStages | StageOptions | This specifies details for feature stages. | | independentStages | IndependentStage[] | This specifies details for independent stages. | | paths | string[] | File path patterns that should trigger the pipeline when changed. | | personalStage | StageOptions | This specifies details for a personal stage. | | pipelineName | string | A unique name for this pipeline, used as a prefix for workflow files, concurrency groups, and artifact names to prevent collisions in monorepos. | | pkgNamespace | string | This field determines the NPM namespace to be used when packaging CDK cloud assemblies. | | postSynthCommands | string[] | *No description.* | | postSynthSteps | PipelineStep[] | *No description.* | | preBuildCommand | string | A command to run before the build step, executed from the repository root. | | preInstallCommands | string[] | *No description.* | | preInstallSteps | PipelineStep[] | *No description.* | | preSynthCommands | string[] | *No description.* | | preSynthSteps | PipelineStep[] | *No description.* | | stackPrefix | string | This field is used to define a prefix for the AWS Stack resources created during the pipeline's operation. | | versioning | VersioningConfig | Versioning configuration. | | workingDirectory | string | The working directory for the pipeline relative to the repository root. | | image | string | The Docker image to use for running the pipeline jobs. | | runnerTags | GitlabRunnerTags | Runner tags configuration for the pipeline. | --- ##### `iamRoleArns`^Required ```typescript public readonly iamRoleArns: IamRoleConfig; ``` - *Type:* IamRoleConfig IAM config. --- ##### `stages`^Required ```typescript public readonly stages: DeploymentStage[]; ``` - *Type:* DeploymentStage[] This field specifies a list of stages that should be deployed using a CI/CD pipeline. --- ##### `branchName`^Optional ```typescript public readonly branchName: string; ``` - *Type:* string - *Default:* main the name of the branch to deploy from. --- ##### `deploySubStacks`^Optional ```typescript public readonly deploySubStacks: boolean; ``` - *Type:* boolean - *Default:* false If set to true all CDK actions will also include /* to deploy/diff/destroy sub stacks of the main stack. You can use this to deploy CDk applications containing multiple stacks. --- ##### `featureStages`^Optional ```typescript public readonly featureStages: StageOptions; ``` - *Type:* StageOptions This specifies details for feature stages. --- ##### `independentStages`^Optional ```typescript public readonly independentStages: IndependentStage[]; ``` - *Type:* IndependentStage[] This specifies details for independent stages. --- ##### `paths`^Optional ```typescript public readonly paths: string[]; ``` - *Type:* string[] - *Default:* all paths trigger the pipeline File path patterns that should trigger the pipeline when changed. This is useful for monorepos where you only want to run the pipeline when files in a specific subproject are modified. For GitHub, these are used as `on.push.paths` and `on.pull_request.paths` filters. For GitLab, these are used as `only.changes` filters. --- *Example* ```typescript ['packages/my-app/**', 'shared-libs/**'] ``` ##### `personalStage`^Optional ```typescript public readonly personalStage: StageOptions; ``` - *Type:* StageOptions This specifies details for a personal stage. --- ##### `pipelineName`^Optional ```typescript public readonly pipelineName: string; ``` - *Type:* string - *Default:* the project name if the project has a parent (monorepo subproject), otherwise no prefix A unique name for this pipeline, used as a prefix for workflow files, concurrency groups, and artifact names to prevent collisions in monorepos. --- ##### `pkgNamespace`^Optional ```typescript public readonly pkgNamespace: string; ``` - *Type:* string - *Default:* This field determines the NPM namespace to be used when packaging CDK cloud assemblies. A namespace helps group related resources together, providing better organization and ease of management. This is only needed if you need to version and upload the cloud assembly to a package repository. --- ##### `postSynthCommands`^Optional ```typescript public readonly postSynthCommands: string[]; ``` - *Type:* string[] --- ##### `postSynthSteps`^Optional ```typescript public readonly postSynthSteps: PipelineStep[]; ``` - *Type:* PipelineStep[] --- ##### `preBuildCommand`^Optional ```typescript public readonly preBuildCommand: string; ``` - *Type:* string - *Default:* no pre-build command A command to run before the build step, executed from the repository root. When a workingDirectory is set (monorepo subproject), the command is automatically wrapped to execute from the repository root regardless of the job's working directory setting. For pnpm workspaces: `pnpm -r --filter ^... run build` For npm workspaces: `npm run build --workspaces --if-present` For yarn workspaces: `yarn workspaces foreach -Rt run build` --- ##### `preInstallCommands`^Optional ```typescript public readonly preInstallCommands: string[]; ``` - *Type:* string[] --- ##### `preInstallSteps`^Optional ```typescript public readonly preInstallSteps: PipelineStep[]; ``` - *Type:* PipelineStep[] --- ##### `preSynthCommands`^Optional ```typescript public readonly preSynthCommands: string[]; ``` - *Type:* string[] --- ##### `preSynthSteps`^Optional ```typescript public readonly preSynthSteps: PipelineStep[]; ``` - *Type:* PipelineStep[] --- ##### `stackPrefix`^Optional ```typescript public readonly stackPrefix: string; ``` - *Type:* string - *Default:* project name This field is used to define a prefix for the AWS Stack resources created during the pipeline's operation. --- ##### `versioning`^Optional ```typescript public readonly versioning: VersioningConfig; ``` - *Type:* VersioningConfig Versioning configuration. --- ##### `workingDirectory`^Optional ```typescript public readonly workingDirectory: string; ``` - *Type:* string - *Default:* automatically computed from the project's position in the monorepo (empty string for root projects) The working directory for the pipeline relative to the repository root. This is automatically computed for subprojects but can be explicitly set. When set, CI jobs will run commands in this directory, and artifact paths will be prefixed accordingly. --- ##### `image`^Optional ```typescript public readonly image: string; ``` - *Type:* string The Docker image to use for running the pipeline jobs. --- ##### `runnerTags`^Optional ```typescript public readonly runnerTags: GitlabRunnerTags; ``` - *Type:* GitlabRunnerTags Runner tags configuration for the pipeline. --- ### GitLabDriftDetectionWorkflowOptions #### Initializer ```typescript import { GitLabDriftDetectionWorkflowOptions } from 'projen-pipelines' const gitLabDriftDetectionWorkflowOptions: GitLabDriftDetectionWorkflowOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | stages | DriftDetectionStageOptions[] | Drift detection configurations for different environments. | | name | string | Name of the workflow. | | pipelineName | string | A unique name for this pipeline, used as a prefix for workflow files and artifact names to prevent collisions in monorepos. | | preInstallSteps | PipelineStep[] | Additional steps to execute before installing dependencies. These steps are executed before the package manager setup and install command. | | schedule | string | Cron schedule for drift detection. | | image | string | Docker image to use for drift detection. | | runnerTags | string[] | GitLab runner tags. | --- ##### `stages`^Required ```typescript public readonly stages: DriftDetectionStageOptions[]; ``` - *Type:* DriftDetectionStageOptions[] Drift detection configurations for different environments. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string - *Default:* "drift-detection" Name of the workflow. --- ##### `pipelineName`^Optional ```typescript public readonly pipelineName: string; ``` - *Type:* string - *Default:* no prefix A unique name for this pipeline, used as a prefix for workflow files and artifact names to prevent collisions in monorepos. --- ##### `preInstallSteps`^Optional ```typescript public readonly preInstallSteps: PipelineStep[]; ``` - *Type:* PipelineStep[] - *Default:* no additional pre-install steps Additional steps to execute before installing dependencies. These steps are executed before the package manager setup and install command. Note: Package manager setup (e.g., PnpmSetupStep for pnpm or CorepackSetupStep for Yarn Berry) is automatically detected from the project and always included. Use this option for any additional pre-install steps you need. --- ##### `schedule`^Optional ```typescript public readonly schedule: string; ``` - *Type:* string - *Default:* "0 0 * * *" (daily at midnight) Cron schedule for drift detection. --- ##### `image`^Optional ```typescript public readonly image: string; ``` - *Type:* string - *Default:* "node:18" Docker image to use for drift detection. --- ##### `runnerTags`^Optional ```typescript public readonly runnerTags: string[]; ``` - *Type:* string[] GitLab runner tags. --- ### GitlabRunnerTags Configuration for GitLab runner tags used within the CI/CD pipeline for various stages. This allows for specifying different runners based on the tags for different stages of the pipeline. #### Initializer ```typescript import { GitlabRunnerTags } from 'projen-pipelines' const gitlabRunnerTags: GitlabRunnerTags = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | assetPublishing | string[] | Runner tags for the asset publishing stage. | | default | string[] | Default runner tags used if specific stage tags are not provided. | | deployment | {[ key: string ]: string[]} | A map of stage names to runner tags for the deployment operation. | | diff | {[ key: string ]: string[]} | A map of stage names to runner tags for the diff operation. | | synth | string[] | Runner tags for the synthesis stage. | --- ##### `assetPublishing`^Optional ```typescript public readonly assetPublishing: string[]; ``` - *Type:* string[] Runner tags for the asset publishing stage. --- ##### `default`^Optional ```typescript public readonly default: string[]; ``` - *Type:* string[] Default runner tags used if specific stage tags are not provided. --- ##### `deployment`^Optional ```typescript public readonly deployment: {[ key: string ]: string[]}; ``` - *Type:* {[ key: string ]: string[]} A map of stage names to runner tags for the deployment operation. --- ##### `diff`^Optional ```typescript public readonly diff: {[ key: string ]: string[]}; ``` - *Type:* {[ key: string ]: string[]} A map of stage names to runner tags for the diff operation. --- ##### `synth`^Optional ```typescript public readonly synth: string[]; ``` - *Type:* string[] Runner tags for the synthesis stage. --- ### GitlabStepConfig Configuration interface for a GitLab CI step. #### Initializer ```typescript import { GitlabStepConfig } from 'projen-pipelines' const gitlabStepConfig: GitlabStepConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | commands | string[] | Shell commands to execute in this step. | | env | {[ key: string ]: string} | Additional environment variables to set for this step. | | extensions | string[] | List of job extensions related to the step. | | needs | projen.gitlab.Need[] | Dependencies which need to be completed before this step. | --- ##### `commands`^Required ```typescript public readonly commands: string[]; ``` - *Type:* string[] Shell commands to execute in this step. --- ##### `env`^Required ```typescript public readonly env: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Additional environment variables to set for this step. --- ##### `extensions`^Required ```typescript public readonly extensions: string[]; ``` - *Type:* string[] List of job extensions related to the step. --- ##### `needs`^Required ```typescript public readonly needs: Need[]; ``` - *Type:* projen.gitlab.Need[] Dependencies which need to be completed before this step. --- ### GitTagConfig #### Initializer ```typescript import { GitTagConfig } from 'projen-pipelines' const gitTagConfig: GitTagConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | annotatedOnly | boolean | Only use annotated tags. | | includeSinceTag | boolean | Include commits since tag. | | pattern | string | Tag pattern to match. | | stripPrefix | string | Strip prefix from tag. | --- ##### `annotatedOnly`^Optional ```typescript public readonly annotatedOnly: boolean; ``` - *Type:* boolean Only use annotated tags. --- ##### `includeSinceTag`^Optional ```typescript public readonly includeSinceTag: boolean; ``` - *Type:* boolean Include commits since tag. --- ##### `pattern`^Optional ```typescript public readonly pattern: string; ``` - *Type:* string Tag pattern to match. --- ##### `stripPrefix`^Optional ```typescript public readonly stripPrefix: string; ``` - *Type:* string Strip prefix from tag. --- ### HierarchicalParametersOptions #### Initializer ```typescript import { HierarchicalParametersOptions } from 'projen-pipelines' const hierarchicalParametersOptions: HierarchicalParametersOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | format | string | *No description.* | | includeCloudFormation | boolean | *No description.* | --- ##### `format`^Optional ```typescript public readonly format: string; ``` - *Type:* string --- ##### `includeCloudFormation`^Optional ```typescript public readonly includeCloudFormation: boolean; ``` - *Type:* boolean --- ### IamRoleConfig Configuration interface for IAM roles used in the CDK pipeline. #### Initializer ```typescript import { IamRoleConfig } from 'projen-pipelines' const iamRoleConfig: IamRoleConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | assetPublishing | string | IAM role ARN for the asset publishing step. | | assetPublishingPerStage | {[ key: string ]: string} | IAM role ARN for the asset publishing step for a specific stage. | | default | string | Default IAM role ARN used if no specific role is provided. | | deployment | {[ key: string ]: string} | IAM role ARNs for different deployment stages. | | diff | {[ key: string ]: string} | IAM role ARNs for different diff stages. | | jump | {[ key: string ]: string} | IAM role ARNs for using a "jump" role to assume the deploy role in a different AWS account using Role Chaining. | | synth | string | IAM role ARN for the synthesis step. | --- ##### `assetPublishing`^Optional ```typescript public readonly assetPublishing: string; ``` - *Type:* string IAM role ARN for the asset publishing step. --- ##### `assetPublishingPerStage`^Optional ```typescript public readonly assetPublishingPerStage: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} IAM role ARN for the asset publishing step for a specific stage. --- ##### `default`^Optional ```typescript public readonly default: string; ``` - *Type:* string Default IAM role ARN used if no specific role is provided. --- ##### `deployment`^Optional ```typescript public readonly deployment: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} IAM role ARNs for different deployment stages. --- ##### `diff`^Optional ```typescript public readonly diff: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} IAM role ARNs for different diff stages. --- ##### `jump`^Optional ```typescript public readonly jump: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} IAM role ARNs for using a "jump" role to assume the deploy role in a different AWS account using Role Chaining. https://github.com/aws-actions/configure-aws-credentials?tab=readme-ov-file#assumerole-with-role-previously-assumed-by-action-in-same-workflow --- ##### `synth`^Optional ```typescript public readonly synth: string; ``` - *Type:* string IAM role ARN for the synthesis step. --- ### IndependentStage Options for stages that are not part of the pipeline. #### Initializer ```typescript import { IndependentStage } from 'projen-pipelines' const independentStage: IndependentStage = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | env | Environment | *No description.* | | name | string | *No description.* | | diffType | CdkDiffType | *No description.* | | githubEnvironment | string | The name of the GitHub environment to use for this stage. | | postDeploySteps | PipelineStep[] | *No description.* | | postDiffSteps | PipelineStep[] | *No description.* | | watchable | boolean | *No description.* | | deployOnPush | boolean | This specifies whether the stage should be deployed on push. | --- ##### `env`^Required ```typescript public readonly env: Environment; ``` - *Type:* Environment --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `diffType`^Optional ```typescript public readonly diffType: CdkDiffType; ``` - *Type:* CdkDiffType --- ##### `githubEnvironment`^Optional ```typescript public readonly githubEnvironment: string; ``` - *Type:* string - *Default:* the stage name The name of the GitHub environment to use for this stage. If not specified, the stage name will be used as the GitHub environment name. --- ##### `postDeploySteps`^Optional ```typescript public readonly postDeploySteps: PipelineStep[]; ``` - *Type:* PipelineStep[] --- ##### `postDiffSteps`^Optional ```typescript public readonly postDiffSteps: PipelineStep[]; ``` - *Type:* PipelineStep[] --- ##### `watchable`^Optional ```typescript public readonly watchable: boolean; ``` - *Type:* boolean --- ##### `deployOnPush`^Optional ```typescript public readonly deployOnPush: boolean; ``` - *Type:* boolean - *Default:* false This specifies whether the stage should be deployed on push. --- ### NamedStageOptions Options for a CDK stage with a name. #### Initializer ```typescript import { NamedStageOptions } from 'projen-pipelines' const namedStageOptions: NamedStageOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | env | Environment | *No description.* | | name | string | *No description.* | | diffType | CdkDiffType | *No description.* | | githubEnvironment | string | The name of the GitHub environment to use for this stage. | | postDeploySteps | PipelineStep[] | *No description.* | | postDiffSteps | PipelineStep[] | *No description.* | | watchable | boolean | *No description.* | --- ##### `env`^Required ```typescript public readonly env: Environment; ``` - *Type:* Environment --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `diffType`^Optional ```typescript public readonly diffType: CdkDiffType; ``` - *Type:* CdkDiffType --- ##### `githubEnvironment`^Optional ```typescript public readonly githubEnvironment: string; ``` - *Type:* string - *Default:* the stage name The name of the GitHub environment to use for this stage. If not specified, the stage name will be used as the GitHub environment name. --- ##### `postDeploySteps`^Optional ```typescript public readonly postDeploySteps: PipelineStep[]; ``` - *Type:* PipelineStep[] --- ##### `postDiffSteps`^Optional ```typescript public readonly postDiffSteps: PipelineStep[]; ``` - *Type:* PipelineStep[] --- ##### `watchable`^Optional ```typescript public readonly watchable: boolean; ``` - *Type:* boolean --- ### NpmSecretStepOptions #### Initializer ```typescript import { NpmSecretStepOptions } from 'projen-pipelines' const npmSecretStepOptions: NpmSecretStepOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | secretName | string | Name of the secret to set for the environment variable NPM_TOKEN. | --- ##### `secretName`^Optional ```typescript public readonly secretName: string; ``` - *Type:* string - *Default:* 'NPM_TOKEN' Name of the secret to set for the environment variable NPM_TOKEN. --- ### PackageJsonConfig #### Initializer ```typescript import { PackageJsonConfig } from 'projen-pipelines' const packageJsonConfig: PackageJsonConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | appendCommitInfo | boolean | Append commit info. | | includePrerelease | boolean | Include pre-release version. | | path | string | Path to package.json. | --- ##### `appendCommitInfo`^Optional ```typescript public readonly appendCommitInfo: boolean; ``` - *Type:* boolean Append commit info. --- ##### `includePrerelease`^Optional ```typescript public readonly includePrerelease: boolean; ``` - *Type:* boolean Include pre-release version. --- ##### `path`^Optional ```typescript public readonly path: string; ``` - *Type:* string Path to package.json. --- ### ParameterStoreConfig #### Initializer ```typescript import { ParameterStoreConfig } from 'projen-pipelines' const parameterStoreConfig: ParameterStoreConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | enabled | boolean | *No description.* | | allowOverwrite | boolean | *No description.* | | description | string | *No description.* | | hierarchical | boolean | *No description.* | | parameterName | string | *No description.* | | splitParameters | boolean | *No description.* | --- ##### `enabled`^Required ```typescript public readonly enabled: boolean; ``` - *Type:* boolean --- ##### `allowOverwrite`^Optional ```typescript public readonly allowOverwrite: boolean; ``` - *Type:* boolean --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `hierarchical`^Optional ```typescript public readonly hierarchical: boolean; ``` - *Type:* boolean --- ##### `parameterName`^Optional ```typescript public readonly parameterName: string; ``` - *Type:* string --- ##### `splitParameters`^Optional ```typescript public readonly splitParameters: boolean; ``` - *Type:* boolean --- ### PnpmSetupStepOptions Options for the PnpmSetupStep. #### Initializer ```typescript import { PnpmSetupStepOptions } from 'projen-pipelines' const pnpmSetupStepOptions: PnpmSetupStepOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | version | string | The version of pnpm to install. | --- ##### `version`^Optional ```typescript public readonly version: string; ``` - *Type:* string The version of pnpm to install. If not provided, defaults to '9'. --- ### StageOptions Options for a CDK stage like the target environment. #### Initializer ```typescript import { StageOptions } from 'projen-pipelines' const stageOptions: StageOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | env | Environment | *No description.* | --- ##### `env`^Required ```typescript public readonly env: Environment; ``` - *Type:* Environment --- ### StandardConfigOptions #### Initializer ```typescript import { StandardConfigOptions } from 'projen-pipelines' const standardConfigOptions: StandardConfigOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | format | string | *No description.* | | parameterStore | string \| boolean | *No description.* | --- ##### `format`^Optional ```typescript public readonly format: string; ``` - *Type:* string --- ##### `parameterStore`^Optional ```typescript public readonly parameterStore: string | boolean; ``` - *Type:* string | boolean --- ### StandardOutputOptions #### Initializer ```typescript import { StandardOutputOptions } from 'projen-pipelines' const standardOutputOptions: StandardOutputOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | format | string | *No description.* | | parameterName | string | *No description.* | --- ##### `format`^Optional ```typescript public readonly format: string; ``` - *Type:* string --- ##### `parameterName`^Optional ```typescript public readonly parameterName: string; ``` - *Type:* string --- ### UploadArtifactStepConfig #### Initializer ```typescript import { UploadArtifactStepConfig } from 'projen-pipelines' const uploadArtifactStepConfig: UploadArtifactStepConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | *No description.* | | path | string | *No description.* | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `path`^Required ```typescript public readonly path: string; ``` - *Type:* string --- ### VersioningConfig #### Initializer ```typescript import { VersioningConfig } from 'projen-pipelines' const versioningConfig: VersioningConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | enabled | boolean | Enable versioning feature. | | outputs | VersioningOutputConfig | Output configuration. | | strategy | IVersioningStrategy | Primary versioning strategy. | | stageOverrides | {[ key: string ]: VersioningConfig} | Stage-specific overrides. | --- ##### `enabled`^Required ```typescript public readonly enabled: boolean; ``` - *Type:* boolean - *Default:* true Enable versioning feature. --- ##### `outputs`^Required ```typescript public readonly outputs: VersioningOutputConfig; ``` - *Type:* VersioningOutputConfig Output configuration. --- ##### `strategy`^Required ```typescript public readonly strategy: IVersioningStrategy; ``` - *Type:* IVersioningStrategy Primary versioning strategy. --- ##### `stageOverrides`^Optional ```typescript public readonly stageOverrides: {[ key: string ]: VersioningConfig}; ``` - *Type:* {[ key: string ]: VersioningConfig} Stage-specific overrides. --- ### VersioningOutputConfig #### Initializer ```typescript import { VersioningOutputConfig } from 'projen-pipelines' const versioningOutputConfig: VersioningOutputConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cloudFormation | CloudFormationOutputConfig | Output to CloudFormation stack outputs. | | parameterStore | ParameterStoreConfig | Output to SSM Parameter Store. | --- ##### `cloudFormation`^Required ```typescript public readonly cloudFormation: CloudFormationOutputConfig; ``` - *Type:* CloudFormationOutputConfig - *Default:* true Output to CloudFormation stack outputs. --- ##### `parameterStore`^Required ```typescript public readonly parameterStore: ParameterStoreConfig; ``` - *Type:* ParameterStoreConfig - *Default:* false Output to SSM Parameter Store. --- ### VersioningStrategyComponents #### Initializer ```typescript import { VersioningStrategyComponents } from 'projen-pipelines' const versioningStrategyComponents: VersioningStrategyComponents = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | commitCount | CommitCountConfig | *No description.* | | gitTag | GitTagConfig | *No description.* | | packageJson | PackageJsonConfig | *No description.* | --- ##### `commitCount`^Optional ```typescript public readonly commitCount: CommitCountConfig; ``` - *Type:* CommitCountConfig --- ##### `gitTag`^Optional ```typescript public readonly gitTag: GitTagConfig; ``` - *Type:* GitTagConfig --- ##### `packageJson`^Optional ```typescript public readonly packageJson: PackageJsonConfig; ``` - *Type:* PackageJsonConfig --- ## Classes ### AmplifyDeployStep A step that deploys a web application to AWS Amplify. #### Initializers ```typescript import { AmplifyDeployStep } from 'projen-pipelines' new AmplifyDeployStep(project: Project, config: AmplifyDeployStepConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | projen.Project | - The projen project reference. | | config | AmplifyDeployStepConfig | *No description.* | --- ##### `project`^Required - *Type:* projen.Project The projen project reference. --- ##### `config`^Required - *Type:* AmplifyDeployStepConfig --- #### Methods | **Name** | **Description** | | --- | --- | | toBash | Generates a configuration for a bash script step. | | toGithub | Generates a configuration for a GitHub Actions step. | | toGitlab | Generates a configuration for a GitLab CI step. | --- ##### `toBash` ```typescript public toBash(): BashStepConfig ``` Generates a configuration for a bash script step. Should be implemented by subclasses. ##### `toGithub` ```typescript public toGithub(): GithubStepConfig ``` Generates a configuration for a GitHub Actions step. Should be implemented by subclasses. ##### `toGitlab` ```typescript public toGitlab(): GitlabStepConfig ``` Generates a configuration for a GitLab CI step. Should be implemented by subclasses. ### AwsAssumeRoleStep A step that assumes a role in AWS. #### Initializers ```typescript import { AwsAssumeRoleStep } from 'projen-pipelines' new AwsAssumeRoleStep(project: Project, config: AwsAssumeRoleStepConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | projen.Project | - The projen project reference. | | config | AwsAssumeRoleStepConfig | *No description.* | --- ##### `project`^Required - *Type:* projen.Project The projen project reference. --- ##### `config`^Required - *Type:* AwsAssumeRoleStepConfig --- #### Methods | **Name** | **Description** | | --- | --- | | toBash | Generates a configuration for a bash script step. | | toGithub | Generates a configuration for a GitHub Actions step. | | toGitlab | Generates a configuration for a GitLab CI step. | --- ##### `toBash` ```typescript public toBash(): BashStepConfig ``` Generates a configuration for a bash script step. Should be implemented by subclasses. ##### `toGithub` ```typescript public toGithub(): GithubStepConfig ``` Generates a configuration for a GitHub Actions step. Should be implemented by subclasses. ##### `toGitlab` ```typescript public toGitlab(): GitlabStepConfig ``` Generates a configuration for a GitLab CI step. Should be implemented by subclasses. ### CdkOutputsSummaryStep A pipeline step that writes CDK stack outputs to the CI/CD job summary. For GitHub Actions: Writes outputs as a markdown table to the job summary. For GitLab CI: Displays outputs in a collapsible section in the job log. This step reads the outputs JSON file generated by CDK deploy and formats it for display in the respective CI/CD platform. #### Initializers ```typescript import { CdkOutputsSummaryStep } from 'projen-pipelines' new CdkOutputsSummaryStep(project: Project, options: CdkOutputsSummaryStepOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | projen.Project | - The projen project reference. | | options | CdkOutputsSummaryStepOptions | *No description.* | --- ##### `project`^Required - *Type:* projen.Project The projen project reference. --- ##### `options`^Required - *Type:* CdkOutputsSummaryStepOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toBash | Generates a configuration for a bash script step. | | toGithub | Converts the step into a GitHub Actions step configuration. | | toGitlab | Converts the step into a GitLab CI step configuration. | --- ##### `toBash` ```typescript public toBash(): BashStepConfig ``` Generates a configuration for a bash script step. Should be implemented by subclasses. ##### `toGithub` ```typescript public toGithub(): GithubStepConfig ``` Converts the step into a GitHub Actions step configuration. ##### `toGitlab` ```typescript public toGitlab(): GitlabStepConfig ``` Converts the step into a GitLab CI step configuration. Creates a collapsible section in the job log to display CDK outputs. ### CloudFormationOutput CloudFormation output configuration. #### Methods | **Name** | **Description** | | --- | --- | | toConfig | Convert to configuration object. | --- ##### `toConfig` ```typescript public toConfig(): any ``` Convert to configuration object. #### Static Functions | **Name** | **Description** | | --- | --- | | disabled | Disable CloudFormation outputs. | | enabled | Enable CloudFormation outputs with default configuration. | | withConfig | Configure CloudFormation outputs with custom settings. | --- ##### `disabled` ```typescript import { CloudFormationOutput } from 'projen-pipelines' CloudFormationOutput.disabled() ``` Disable CloudFormation outputs. ##### `enabled` ```typescript import { CloudFormationOutput } from 'projen-pipelines' CloudFormationOutput.enabled() ``` Enable CloudFormation outputs with default configuration. ##### `withConfig` ```typescript import { CloudFormationOutput } from 'projen-pipelines' CloudFormationOutput.withConfig(config: CloudFormationOutputConfig) ``` Configure CloudFormation outputs with custom settings. ###### `config`^Required - *Type:* CloudFormationOutputConfig --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | type | string | *No description.* | --- ##### `type`^Required ```typescript public readonly type: string; ``` - *Type:* string --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | TYPE | string | *No description.* | --- ##### `TYPE`^Required ```typescript public readonly TYPE: string; ``` - *Type:* string --- ### CodeArtifactLoginStep Step to login to CodeArtifact. The environment variable name can be configured to avoid conflicts with other environment variables. The default is CODEARTIFACT_AUTH_TOKEN. #### Initializers ```typescript import { CodeArtifactLoginStep } from 'projen-pipelines' new CodeArtifactLoginStep(project: Project, options: CodeArtifactLoginStepOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | projen.Project | - The projen project reference. | | options | CodeArtifactLoginStepOptions | *No description.* | --- ##### `project`^Required - *Type:* projen.Project The projen project reference. --- ##### `options`^Required - *Type:* CodeArtifactLoginStepOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toBash | Converts the sequence of steps into a Bash script configuration. | | toGithub | Converts the sequence of steps into a GitHub Actions step configuration. | | toGitlab | Converts the sequence of steps into a GitLab CI configuration. | | addSteps | *No description.* | | prependSteps | *No description.* | --- ##### `toBash` ```typescript public toBash(): BashStepConfig ``` Converts the sequence of steps into a Bash script configuration. ##### `toGithub` ```typescript public toGithub(): GithubStepConfig ``` Converts the sequence of steps into a GitHub Actions step configuration. ##### `toGitlab` ```typescript public toGitlab(): GitlabStepConfig ``` Converts the sequence of steps into a GitLab CI configuration. ##### `addSteps` ```typescript public addSteps(steps: ...PipelineStep[]): void ``` ###### `steps`^Required - *Type:* ...PipelineStep[] --- ##### `prependSteps` ```typescript public prependSteps(steps: ...PipelineStep[]): void ``` ###### `steps`^Required - *Type:* ...PipelineStep[] --- ### CompositeComputation Composite version computation that combines multiple strategies. #### Initializers ```typescript import { CompositeComputation } from 'projen-pipelines' new CompositeComputation(strategy: VersioningStrategy) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | strategy | VersioningStrategy | *No description.* | --- ##### `strategy`^Required - *Type:* VersioningStrategy --- #### Methods | **Name** | **Description** | | --- | --- | | computeVersion | Compute version string from context. | | createVersionInfo | Create VersionInfo from context. | --- ##### `computeVersion` ```typescript public computeVersion(context: ComputationContext): string ``` Compute version string from context. ###### `context`^Required - *Type:* ComputationContext --- ##### `createVersionInfo` ```typescript public createVersionInfo(context: ComputationContext): VersionInfo ``` Create VersionInfo from context. ###### `context`^Required - *Type:* ComputationContext --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | strategy | VersioningStrategy | *No description.* | --- ##### `strategy`^Required ```typescript public readonly strategy: VersioningStrategy; ``` - *Type:* VersioningStrategy --- ### CorepackSetupStep Step to enable corepack for Yarn Berry support. This step is automatically injected when a project uses Yarn Berry as its package manager. It ensures corepack is enabled in the CI environment before running any yarn commands, which is required for Yarn Berry (v2+) to work correctly. #### Initializers ```typescript import { CorepackSetupStep } from 'projen-pipelines' new CorepackSetupStep(project: Project) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | projen.Project | - The projen project reference. | --- ##### `project`^Required - *Type:* projen.Project The projen project reference. --- #### Methods | **Name** | **Description** | | --- | --- | | toBash | Generates a configuration for a bash script step. | | toGithub | Generates a configuration for a GitHub Actions step. | | toGitlab | Generates a configuration for a GitLab CI step. | --- ##### `toBash` ```typescript public toBash(): BashStepConfig ``` Generates a configuration for a bash script step. Should be implemented by subclasses. ##### `toGithub` ```typescript public toGithub(): GithubStepConfig ``` Generates a configuration for a GitHub Actions step. Should be implemented by subclasses. ##### `toGitlab` ```typescript public toGitlab(): GitlabStepConfig ``` Generates a configuration for a GitLab CI step. Should be implemented by subclasses. ### DownloadArtifactStep #### Initializers ```typescript import { DownloadArtifactStep } from 'projen-pipelines' new DownloadArtifactStep(project: Project, config: DownloadArtifactStepConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | projen.Project | - The projen project reference. | | config | DownloadArtifactStepConfig | *No description.* | --- ##### `project`^Required - *Type:* projen.Project The projen project reference. --- ##### `config`^Required - *Type:* DownloadArtifactStepConfig --- #### Methods | **Name** | **Description** | | --- | --- | | toBash | Generates a configuration for a bash script step. | | toGithub | Generates a configuration for a GitHub Actions step. | | toGitlab | Generates a configuration for a GitLab CI step. | --- ##### `toBash` ```typescript public toBash(): BashStepConfig ``` Generates a configuration for a bash script step. Should be implemented by subclasses. ##### `toGithub` ```typescript public toGithub(): GithubStepConfig ``` Generates a configuration for a GitHub Actions step. Should be implemented by subclasses. ##### `toGitlab` ```typescript public toGitlab(): GitlabStepConfig ``` Generates a configuration for a GitLab CI step. Should be implemented by subclasses. ### DriftDetectionStep #### Initializers ```typescript import { DriftDetectionStep } from 'projen-pipelines' new DriftDetectionStep(project: Project, props: DriftDetectionStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | projen.Project | - The projen project reference. | | props | DriftDetectionStepProps | *No description.* | --- ##### `project`^Required - *Type:* projen.Project The projen project reference. --- ##### `props`^Required - *Type:* DriftDetectionStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toBash | Converts the sequence of steps into a Bash script configuration. | | toGithub | Converts the sequence of steps into a GitHub Actions step configuration. | | toGitlab | Converts the sequence of steps into a GitLab CI configuration. | | addSteps | *No description.* | | prependSteps | *No description.* | --- ##### `toBash` ```typescript public toBash(): BashStepConfig ``` Converts the sequence of steps into a Bash script configuration. ##### `toGithub` ```typescript public toGithub(): GithubStepConfig ``` Converts the sequence of steps into a GitHub Actions step configuration. ##### `toGitlab` ```typescript public toGitlab(): GitlabStepConfig ``` Converts the sequence of steps into a GitLab CI configuration. ##### `addSteps` ```typescript public addSteps(steps: ...PipelineStep[]): void ``` ###### `steps`^Required - *Type:* ...PipelineStep[] --- ##### `prependSteps` ```typescript public prependSteps(steps: ...PipelineStep[]): void ``` ###### `steps`^Required - *Type:* ...PipelineStep[] --- ### GithubPackagesLoginStep Step to set the GITHUB_TOKEN environment variable from a secret. Only supported for GitHub as it is GitHub specific. #### Initializers ```typescript import { GithubPackagesLoginStep } from 'projen-pipelines' new GithubPackagesLoginStep(project: Project, options: GithubPackagesLoginStepOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | projen.Project | - The projen project reference. | | options | GithubPackagesLoginStepOptions | *No description.* | --- ##### `project`^Required - *Type:* projen.Project The projen project reference. --- ##### `options`^Required - *Type:* GithubPackagesLoginStepOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toBash | Generates a configuration for a bash script step. | | toGithub | Generates a configuration for a GitHub Actions step. | | toGitlab | Generates a configuration for a GitLab CI step. | --- ##### `toBash` ```typescript public toBash(): BashStepConfig ``` Generates a configuration for a bash script step. Should be implemented by subclasses. ##### `toGithub` ```typescript public toGithub(): GithubStepConfig ``` Generates a configuration for a GitHub Actions step. Should be implemented by subclasses. ##### `toGitlab` ```typescript public toGitlab(): GitlabStepConfig ``` Generates a configuration for a GitLab CI step. Should be implemented by subclasses. ### NpmSecretStep Step to set the NPM_TOKEN environment variable from a secret. Currently only supported and needed for GitHub. Gitlab sets the NPM_TOKEN environment variable automatically from the project's settings. #### Initializers ```typescript import { NpmSecretStep } from 'projen-pipelines' new NpmSecretStep(project: Project, options: NpmSecretStepOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | projen.Project | - The projen project reference. | | options | NpmSecretStepOptions | *No description.* | --- ##### `project`^Required - *Type:* projen.Project The projen project reference. --- ##### `options`^Required - *Type:* NpmSecretStepOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toBash | Generates a configuration for a bash script step. | | toGithub | Generates a configuration for a GitHub Actions step. | | toGitlab | Generates a configuration for a GitLab CI step. | --- ##### `toBash` ```typescript public toBash(): BashStepConfig ``` Generates a configuration for a bash script step. Should be implemented by subclasses. ##### `toGithub` ```typescript public toGithub(): GithubStepConfig ``` Generates a configuration for a GitHub Actions step. Should be implemented by subclasses. ##### `toGitlab` ```typescript public toGitlab(): GitlabStepConfig ``` Generates a configuration for a GitLab CI step. Should be implemented by subclasses. ### OutputConfigBase Base class for output configurations. #### Initializers ```typescript import { OutputConfigBase } from 'projen-pipelines' new OutputConfigBase(type: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | type | string | *No description.* | --- ##### `type`^Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | toConfig | Convert to configuration object. | --- ##### `toConfig` ```typescript public toConfig(): any ``` Convert to configuration object. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | type | string | *No description.* | --- ##### `type`^Required ```typescript public readonly type: string; ``` - *Type:* string --- ### OutputFormat Output format types. #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | PLAIN | string | *No description.* | | STRUCTURED | string | *No description.* | --- ##### `PLAIN`^Required ```typescript public readonly PLAIN: string; ``` - *Type:* string --- ##### `STRUCTURED`^Required ```typescript public readonly STRUCTURED: string; ``` - *Type:* string --- ### ParameterStoreOutput SSM Parameter Store output configuration. #### Methods | **Name** | **Description** | | --- | --- | | toConfig | Convert to configuration object. | --- ##### `toConfig` ```typescript public toConfig(): any ``` Convert to configuration object. #### Static Functions | **Name** | **Description** | | --- | --- | | disabled | Disable Parameter Store outputs. | | enabled | Enable Parameter Store outputs with parameter name. | | hierarchical | Configure Parameter Store with hierarchical parameters. | | withConfig | Configure Parameter Store outputs with custom settings. | --- ##### `disabled` ```typescript import { ParameterStoreOutput } from 'projen-pipelines' ParameterStoreOutput.disabled() ``` Disable Parameter Store outputs. ##### `enabled` ```typescript import { ParameterStoreOutput } from 'projen-pipelines' ParameterStoreOutput.enabled(parameterName: string) ``` Enable Parameter Store outputs with parameter name. ###### `parameterName`^Required - *Type:* string --- ##### `hierarchical` ```typescript import { ParameterStoreOutput } from 'projen-pipelines' ParameterStoreOutput.hierarchical(basePath: string, options?: HierarchicalParametersOptions) ``` Configure Parameter Store with hierarchical parameters. ###### `basePath`^Required - *Type:* string --- ###### `options`^Optional - *Type:* HierarchicalParametersOptions --- ##### `withConfig` ```typescript import { ParameterStoreOutput } from 'projen-pipelines' ParameterStoreOutput.withConfig(config: ParameterStoreConfig) ``` Configure Parameter Store outputs with custom settings. ###### `config`^Required - *Type:* ParameterStoreConfig --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | type | string | *No description.* | --- ##### `type`^Required ```typescript public readonly type: string; ``` - *Type:* string --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | TYPE | string | *No description.* | --- ##### `TYPE`^Required ```typescript public readonly TYPE: string; ``` - *Type:* string --- ### PipelineStep Abstract class defining the structure of a pipeline step. #### Initializers ```typescript import { PipelineStep } from 'projen-pipelines' new PipelineStep(project: Project) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | projen.Project | - The projen project reference. | --- ##### `project`^Required - *Type:* projen.Project The projen project reference. --- #### Methods | **Name** | **Description** | | --- | --- | | toBash | Generates a configuration for a bash script step. | | toGithub | Generates a configuration for a GitHub Actions step. | | toGitlab | Generates a configuration for a GitLab CI step. | --- ##### `toBash` ```typescript public toBash(): BashStepConfig ``` Generates a configuration for a bash script step. Should be implemented by subclasses. ##### `toGithub` ```typescript public toGithub(): GithubStepConfig ``` Generates a configuration for a GitHub Actions step. Should be implemented by subclasses. ##### `toGitlab` ```typescript public toGitlab(): GitlabStepConfig ``` Generates a configuration for a GitLab CI step. Should be implemented by subclasses. ### PnpmSetupStep Step to setup pnpm using the pnpm/action-setup GitHub Action. This step is automatically injected when a project uses pnpm as its package manager. It ensures pnpm is available in the GitHub Actions workflow environment before running any install commands. #### Initializers ```typescript import { PnpmSetupStep } from 'projen-pipelines' new PnpmSetupStep(project: Project, options?: PnpmSetupStepOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | projen.Project | - The projen project reference. | | options | PnpmSetupStepOptions | *No description.* | --- ##### `project`^Required - *Type:* projen.Project The projen project reference. --- ##### `options`^Optional - *Type:* PnpmSetupStepOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toBash | Generates a configuration for a bash script step. | | toGithub | Generates a configuration for a GitHub Actions step. | | toGitlab | Generates a configuration for a GitLab CI step. | --- ##### `toBash` ```typescript public toBash(): BashStepConfig ``` Generates a configuration for a bash script step. Should be implemented by subclasses. ##### `toGithub` ```typescript public toGithub(): GithubStepConfig ``` Generates a configuration for a GitHub Actions step. Should be implemented by subclasses. ##### `toGitlab` ```typescript public toGitlab(): GitlabStepConfig ``` Generates a configuration for a GitLab CI step. Should be implemented by subclasses. ### ProjenScriptStep #### Initializers ```typescript import { ProjenScriptStep } from 'projen-pipelines' new ProjenScriptStep(project: Project, scriptName: string, args?: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | projen.Project | - The projen project reference. | | scriptName | string | *No description.* | | args | string | *No description.* | --- ##### `project`^Required - *Type:* projen.Project The projen project reference. --- ##### `scriptName`^Required - *Type:* string --- ##### `args`^Optional - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | toBash | Converts the step into a Bash script configuration. | | toGithub | Converts the step into a GitHub Actions step configuration. | | toGitlab | Converts the step into a GitLab CI configuration. | --- ##### `toBash` ```typescript public toBash(): BashStepConfig ``` Converts the step into a Bash script configuration. ##### `toGithub` ```typescript public toGithub(): GithubStepConfig ``` Converts the step into a GitHub Actions step configuration. ##### `toGitlab` ```typescript public toGitlab(): GitlabStepConfig ``` Converts the step into a GitLab CI configuration. ### SimpleCommandStep Concrete implementation of PipelineStep that executes simple commands. #### Initializers ```typescript import { SimpleCommandStep } from 'projen-pipelines' new SimpleCommandStep(project: Project, commands: string[], env?: {[ key: string ]: string}) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | projen.Project | - The projen project reference. | | commands | string[] | - Shell commands to execute. | | env | {[ key: string ]: string} | *No description.* | --- ##### `project`^Required - *Type:* projen.Project The projen project reference. --- ##### `commands`^Required - *Type:* string[] Shell commands to execute. --- ##### `env`^Optional - *Type:* {[ key: string ]: string} --- #### Methods | **Name** | **Description** | | --- | --- | | toBash | Converts the step into a Bash script configuration. | | toGithub | Converts the step into a GitHub Actions step configuration. | | toGitlab | Converts the step into a GitLab CI configuration. | --- ##### `toBash` ```typescript public toBash(): BashStepConfig ``` Converts the step into a Bash script configuration. ##### `toGithub` ```typescript public toGithub(): GithubStepConfig ``` Converts the step into a GitHub Actions step configuration. ##### `toGitlab` ```typescript public toGitlab(): GitlabStepConfig ``` Converts the step into a GitLab CI configuration. ### StepSequence #### Initializers ```typescript import { StepSequence } from 'projen-pipelines' new StepSequence(project: Project, steps: PipelineStep[]) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | projen.Project | - The projen project reference. | | steps | PipelineStep[] | - The sequence of pipeline steps. | --- ##### `project`^Required - *Type:* projen.Project The projen project reference. --- ##### `steps`^Required - *Type:* PipelineStep[] The sequence of pipeline steps. --- #### Methods | **Name** | **Description** | | --- | --- | | toBash | Converts the sequence of steps into a Bash script configuration. | | toGithub | Converts the sequence of steps into a GitHub Actions step configuration. | | toGitlab | Converts the sequence of steps into a GitLab CI configuration. | | addSteps | *No description.* | | prependSteps | *No description.* | --- ##### `toBash` ```typescript public toBash(): BashStepConfig ``` Converts the sequence of steps into a Bash script configuration. ##### `toGithub` ```typescript public toGithub(): GithubStepConfig ``` Converts the sequence of steps into a GitHub Actions step configuration. ##### `toGitlab` ```typescript public toGitlab(): GitlabStepConfig ``` Converts the sequence of steps into a GitLab CI configuration. ##### `addSteps` ```typescript public addSteps(steps: ...PipelineStep[]): void ``` ###### `steps`^Required - *Type:* ...PipelineStep[] --- ##### `prependSteps` ```typescript public prependSteps(steps: ...PipelineStep[]): void ``` ###### `steps`^Required - *Type:* ...PipelineStep[] --- ### UploadArtifactStep #### Initializers ```typescript import { UploadArtifactStep } from 'projen-pipelines' new UploadArtifactStep(project: Project, config: UploadArtifactStepConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | projen.Project | - The projen project reference. | | config | UploadArtifactStepConfig | *No description.* | --- ##### `project`^Required - *Type:* projen.Project The projen project reference. --- ##### `config`^Required - *Type:* UploadArtifactStepConfig --- #### Methods | **Name** | **Description** | | --- | --- | | toBash | Generates a configuration for a bash script step. | | toGithub | Generates a configuration for a GitHub Actions step. | | toGitlab | Generates a configuration for a GitLab CI step. | --- ##### `toBash` ```typescript public toBash(): BashStepConfig ``` Generates a configuration for a bash script step. Should be implemented by subclasses. ##### `toGithub` ```typescript public toGithub(): GithubStepConfig ``` Generates a configuration for a GitHub Actions step. Should be implemented by subclasses. ##### `toGitlab` ```typescript public toGitlab(): GitlabStepConfig ``` Generates a configuration for a GitLab CI step. Should be implemented by subclasses. ### VersionComputationStrategy Base class for version computation strategies. #### Initializers ```typescript import { VersionComputationStrategy } from 'projen-pipelines' new VersionComputationStrategy(strategy: VersioningStrategy) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | strategy | VersioningStrategy | *No description.* | --- ##### `strategy`^Required - *Type:* VersioningStrategy --- #### Methods | **Name** | **Description** | | --- | --- | | computeVersion | Compute version string from context. | | createVersionInfo | Create VersionInfo from context. | --- ##### `computeVersion` ```typescript public computeVersion(context: ComputationContext): string ``` Compute version string from context. ###### `context`^Required - *Type:* ComputationContext --- ##### `createVersionInfo` ```typescript public createVersionInfo(context: ComputationContext): VersionInfo ``` Create VersionInfo from context. ###### `context`^Required - *Type:* ComputationContext --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | strategy | VersioningStrategy | *No description.* | --- ##### `strategy`^Required ```typescript public readonly strategy: VersioningStrategy; ``` - *Type:* VersioningStrategy --- ### VersionComputer Main version computer that handles strategy selection. #### Initializers ```typescript import { VersionComputer } from 'projen-pipelines' new VersionComputer(strategy: IVersioningStrategy) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | strategy | IVersioningStrategy | *No description.* | --- ##### `strategy`^Required - *Type:* IVersioningStrategy --- #### Methods | **Name** | **Description** | | --- | --- | | computeVersionInfo | Compute version info from context. | --- ##### `computeVersionInfo` ```typescript public computeVersionInfo(context: ComputationContext): VersionInfo ``` Compute version info from context. ###### `context`^Required - *Type:* ComputationContext --- ### VersionInfo - *Implements:* IVersionInfo Represents complete version information for a deployment. #### Methods | **Name** | **Description** | | --- | --- | | compare | Compare with another version Returns: -1 if this < other, 0 if equal, 1 if this > other. | | displayVersion | Get formatted version for display. | | exportName | Create CloudFormation export name. | | mainBranch | Check if this version is from the main branch. | | parameterName | Create a parameter name for SSM Parameter Store. | | taggedRelease | Check if this version is from a tagged release. | | toJson | Convert to JSON string. | | toObject | Convert to object. | | toString | Convert to plain version string. | --- ##### `compare` ```typescript public compare(other: VersionInfo): number ``` Compare with another version Returns: -1 if this < other, 0 if equal, 1 if this > other. ###### `other`^Required - *Type:* VersionInfo --- ##### `displayVersion` ```typescript public displayVersion(): string ``` Get formatted version for display. ##### `exportName` ```typescript public exportName(template: string): string ``` Create CloudFormation export name. ###### `template`^Required - *Type:* string --- ##### `mainBranch` ```typescript public mainBranch(): boolean ``` Check if this version is from the main branch. ##### `parameterName` ```typescript public parameterName(template: string): string ``` Create a parameter name for SSM Parameter Store. ###### `template`^Required - *Type:* string --- ##### `taggedRelease` ```typescript public taggedRelease(): boolean ``` Check if this version is from a tagged release. ##### `toJson` ```typescript public toJson(pretty?: boolean): string ``` Convert to JSON string. ###### `pretty`^Optional - *Type:* boolean --- ##### `toObject` ```typescript public toObject(): IVersionInfo ``` Convert to object. ##### `toString` ```typescript public toString(): string ``` Convert to plain version string. #### Static Functions | **Name** | **Description** | | --- | --- | | create | Create a VersionInfo instance from raw data. | | fromEnvironment | Create a VersionInfo instance from environment variables. | | fromJson | Create a VersionInfo instance from a JSON string. | --- ##### `create` ```typescript import { VersionInfo } from 'projen-pipelines' VersionInfo.create(props: IVersionInfo) ``` Create a VersionInfo instance from raw data. ###### `props`^Required - *Type:* IVersionInfo --- ##### `fromEnvironment` ```typescript import { VersionInfo } from 'projen-pipelines' VersionInfo.fromEnvironment(env: {[ key: string ]: string}) ``` Create a VersionInfo instance from environment variables. ###### `env`^Required - *Type:* {[ key: string ]: string} --- ##### `fromJson` ```typescript import { VersionInfo } from 'projen-pipelines' VersionInfo.fromJson(json: string) ``` Create a VersionInfo instance from a JSON string. ###### `json`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | branch | string | *No description.* | | commitCount | number | Commit count information. | | commitHash | string | Git information (ALWAYS included). | | commitHashShort | string | *No description.* | | deployedAt | string | Deployment metadata. | | deployedBy | string | *No description.* | | environment | string | *No description.* | | version | string | Primary version string. | | buildNumber | string | *No description.* | | commitsSinceTag | number | *No description.* | | packageVersion | string | Package.json information (if applicable). | | pipelineVersion | string | *No description.* | | repository | string | Additional metadata. | | tag | string | Optional git tag information. | --- ##### `branch`^Required ```typescript public readonly branch: string; ``` - *Type:* string --- ##### `commitCount`^Required ```typescript public readonly commitCount: number; ``` - *Type:* number Commit count information. --- ##### `commitHash`^Required ```typescript public readonly commitHash: string; ``` - *Type:* string Git information (ALWAYS included). --- ##### `commitHashShort`^Required ```typescript public readonly commitHashShort: string; ``` - *Type:* string --- ##### `deployedAt`^Required ```typescript public readonly deployedAt: string; ``` - *Type:* string Deployment metadata. --- ##### `deployedBy`^Required ```typescript public readonly deployedBy: string; ``` - *Type:* string --- ##### `environment`^Required ```typescript public readonly environment: string; ``` - *Type:* string --- ##### `version`^Required ```typescript public readonly version: string; ``` - *Type:* string Primary version string. --- ##### `buildNumber`^Optional ```typescript public readonly buildNumber: string; ``` - *Type:* string --- ##### `commitsSinceTag`^Optional ```typescript public readonly commitsSinceTag: number; ``` - *Type:* number --- ##### `packageVersion`^Optional ```typescript public readonly packageVersion: string; ``` - *Type:* string Package.json information (if applicable). --- ##### `pipelineVersion`^Optional ```typescript public readonly pipelineVersion: string; ``` - *Type:* string --- ##### `repository`^Optional ```typescript public readonly repository: string; ``` - *Type:* string Additional metadata. --- ##### `tag`^Optional ```typescript public readonly tag: string; ``` - *Type:* string Optional git tag information. --- ### VersionInfoBuilder Builder class for creating VersionInfo instances. #### Initializers ```typescript import { VersionInfoBuilder } from 'projen-pipelines' new VersionInfoBuilder() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | create | Build the VersionInfo instance. | | deploymentInfo | Set deployment metadata. | | gitInfo | Set git information. | | packageVersion | Set package version. | | pipelineVersion | Set pipeline version. | | repository | Set repository information. | | version | Set the version string. | --- ##### `create` ```typescript public create(): VersionInfo ``` Build the VersionInfo instance. ##### `deploymentInfo` ```typescript public deploymentInfo(info: DeploymentInfoInput): VersionInfoBuilder ``` Set deployment metadata. ###### `info`^Required - *Type:* DeploymentInfoInput --- ##### `gitInfo` ```typescript public gitInfo(info: GitInfoInput): VersionInfoBuilder ``` Set git information. ###### `info`^Required - *Type:* GitInfoInput --- ##### `packageVersion` ```typescript public packageVersion(version: string): VersionInfoBuilder ``` Set package version. ###### `version`^Required - *Type:* string --- ##### `pipelineVersion` ```typescript public pipelineVersion(version: string): VersionInfoBuilder ``` Set pipeline version. ###### `version`^Required - *Type:* string --- ##### `repository` ```typescript public repository(repo: string): VersionInfoBuilder ``` Set repository information. ###### `repo`^Required - *Type:* string --- ##### `version` ```typescript public version(version: string): VersionInfoBuilder ``` Set the version string. ###### `version`^Required - *Type:* string --- ### VersioningConfigurations Main versioning configuration class with factory methods. #### Initializers ```typescript import { VersioningConfigurations } from 'projen-pipelines' new VersioningConfigurations() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Static Functions | **Name** | **Description** | | --- | --- | | custom | Create a custom configuration. | | minimal | Minimal configuration for testing. | | standard | Standard configuration with commit count strategy. | --- ##### `custom` ```typescript import { VersioningConfigurations } from 'projen-pipelines' VersioningConfigurations.custom(config: CustomVersioningConfig) ``` Create a custom configuration. ###### `config`^Required - *Type:* CustomVersioningConfig --- ##### `minimal` ```typescript import { VersioningConfigurations } from 'projen-pipelines' VersioningConfigurations.minimal() ``` Minimal configuration for testing. ##### `standard` ```typescript import { VersioningConfigurations } from 'projen-pipelines' VersioningConfigurations.standard(options?: StandardConfigOptions) ``` Standard configuration with commit count strategy. ###### `options`^Optional - *Type:* StandardConfigOptions --- ### VersioningConfigUtils Utility functions for versioning configuration. #### Initializers ```typescript import { VersioningConfigUtils } from 'projen-pipelines' new VersioningConfigUtils() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Static Functions | **Name** | **Description** | | --- | --- | | default | Get default configuration. | | resolveForStage | Resolve configuration for a specific stage. | | validate | Validate configuration. | --- ##### `default` ```typescript import { VersioningConfigUtils } from 'projen-pipelines' VersioningConfigUtils.default() ``` Get default configuration. ##### `resolveForStage` ```typescript import { VersioningConfigUtils } from 'projen-pipelines' VersioningConfigUtils.resolveForStage(config: VersioningConfig, stage: string) ``` Resolve configuration for a specific stage. ###### `config`^Required - *Type:* VersioningConfig --- ###### `stage`^Required - *Type:* string --- ##### `validate` ```typescript import { VersioningConfigUtils } from 'projen-pipelines' VersioningConfigUtils.validate(config: VersioningConfig) ``` Validate configuration. ###### `config`^Required - *Type:* VersioningConfig --- ### VersioningOutputs Factory class for output configurations. #### Initializers ```typescript import { VersioningOutputs } from 'projen-pipelines' new VersioningOutputs() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Static Functions | **Name** | **Description** | | --- | --- | | cloudFormationOnly | Create output configuration with only CloudFormation. | | hierarchicalParameters | Create output configuration with hierarchical SSM parameters. | | minimal | Create minimal output configuration (CloudFormation only, plain format). | | standard | Create output configuration with CloudFormation and SSM Parameter Store. | --- ##### `cloudFormationOnly` ```typescript import { VersioningOutputs } from 'projen-pipelines' VersioningOutputs.cloudFormationOnly(options?: CloudFormationOnlyOptions) ``` Create output configuration with only CloudFormation. ###### `options`^Optional - *Type:* CloudFormationOnlyOptions --- ##### `hierarchicalParameters` ```typescript import { VersioningOutputs } from 'projen-pipelines' VersioningOutputs.hierarchicalParameters(basePath: string, options?: HierarchicalParametersOptions) ``` Create output configuration with hierarchical SSM parameters. ###### `basePath`^Required - *Type:* string --- ###### `options`^Optional - *Type:* HierarchicalParametersOptions --- ##### `minimal` ```typescript import { VersioningOutputs } from 'projen-pipelines' VersioningOutputs.minimal() ``` Create minimal output configuration (CloudFormation only, plain format). ##### `standard` ```typescript import { VersioningOutputs } from 'projen-pipelines' VersioningOutputs.standard(options?: StandardOutputOptions) ``` Create output configuration with CloudFormation and SSM Parameter Store. ###### `options`^Optional - *Type:* StandardOutputOptions --- ### VersioningSetup Sets up versioning tasks and integration for a project. #### Initializers ```typescript import { VersioningSetup } from 'projen-pipelines' new VersioningSetup(project: Project, config: VersioningConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | projen.Project | *No description.* | | config | VersioningConfig | *No description.* | --- ##### `project`^Required - *Type:* projen.Project --- ##### `config`^Required - *Type:* VersioningConfig --- #### Methods | **Name** | **Description** | | --- | --- | | setup | Set up all versioning-related tasks and configurations. | --- ##### `setup` ```typescript public setup(): void ``` Set up all versioning-related tasks and configurations. ### VersioningStrategy - *Implements:* IVersioningStrategy Composite versioning strategy that combines multiple strategies. #### Static Functions | **Name** | **Description** | | --- | --- | | buildNumber | Create a build number based strategy. | | commitCount | *No description.* | | commitHash | *No description.* | | create | Create a composite strategy with custom format and components. | | gitTag | *No description.* | | packageJson | *No description.* | --- ##### `buildNumber` ```typescript import { VersioningStrategy } from 'projen-pipelines' VersioningStrategy.buildNumber(config?: BuildNumberConfig) ``` Create a build number based strategy. ###### `config`^Optional - *Type:* BuildNumberConfig --- ##### `commitCount` ```typescript import { VersioningStrategy } from 'projen-pipelines' VersioningStrategy.commitCount(config?: CommitCountConfig) ``` ###### `config`^Optional - *Type:* CommitCountConfig --- ##### `commitHash` ```typescript import { VersioningStrategy } from 'projen-pipelines' VersioningStrategy.commitHash() ``` ##### `create` ```typescript import { VersioningStrategy } from 'projen-pipelines' VersioningStrategy.create(format: string, components: VersioningStrategyComponents) ``` Create a composite strategy with custom format and components. ###### `format`^Required - *Type:* string --- ###### `components`^Required - *Type:* VersioningStrategyComponents --- ##### `gitTag` ```typescript import { VersioningStrategy } from 'projen-pipelines' VersioningStrategy.gitTag(config?: GitTagConfig) ``` ###### `config`^Optional - *Type:* GitTagConfig --- ##### `packageJson` ```typescript import { VersioningStrategy } from 'projen-pipelines' VersioningStrategy.packageJson(config?: PackageJsonConfig) ``` ###### `config`^Optional - *Type:* PackageJsonConfig --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | components | VersioningStrategyComponents | Components to include. | | format | string | Version format template Variables: {git-tag}, {package-version}, {commit-count}, {commit-hash}, {commit-hash:8}, {branch}, {build-number}. | --- ##### `components`^Required ```typescript public readonly components: VersioningStrategyComponents; ``` - *Type:* VersioningStrategyComponents Components to include. --- ##### `format`^Required ```typescript public readonly format: string; ``` - *Type:* string Version format template Variables: {git-tag}, {package-version}, {commit-count}, {commit-hash}, {commit-hash:8}, {branch}, {build-number}. --- ## Protocols ### IVersionInfo - *Implemented By:* VersionInfo, IVersionInfo #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | branch | string | *No description.* | | commitCount | number | Commit count information. | | commitHash | string | Git information (ALWAYS included). | | commitHashShort | string | *No description.* | | deployedAt | string | Deployment metadata. | | deployedBy | string | *No description.* | | environment | string | *No description.* | | version | string | Primary version string. | | buildNumber | string | *No description.* | | commitsSinceTag | number | *No description.* | | packageVersion | string | Package.json information (if applicable). | | pipelineVersion | string | *No description.* | | repository | string | Additional metadata. | | tag | string | Optional git tag information. | --- ##### `branch`^Required ```typescript public readonly branch: string; ``` - *Type:* string --- ##### `commitCount`^Required ```typescript public readonly commitCount: number; ``` - *Type:* number Commit count information. --- ##### `commitHash`^Required ```typescript public readonly commitHash: string; ``` - *Type:* string Git information (ALWAYS included). --- ##### `commitHashShort`^Required ```typescript public readonly commitHashShort: string; ``` - *Type:* string --- ##### `deployedAt`^Required ```typescript public readonly deployedAt: string; ``` - *Type:* string Deployment metadata. --- ##### `deployedBy`^Required ```typescript public readonly deployedBy: string; ``` - *Type:* string --- ##### `environment`^Required ```typescript public readonly environment: string; ``` - *Type:* string --- ##### `version`^Required ```typescript public readonly version: string; ``` - *Type:* string Primary version string. --- ##### `buildNumber`^Optional ```typescript public readonly buildNumber: string; ``` - *Type:* string --- ##### `commitsSinceTag`^Optional ```typescript public readonly commitsSinceTag: number; ``` - *Type:* number --- ##### `packageVersion`^Optional ```typescript public readonly packageVersion: string; ``` - *Type:* string Package.json information (if applicable). --- ##### `pipelineVersion`^Optional ```typescript public readonly pipelineVersion: string; ``` - *Type:* string --- ##### `repository`^Optional ```typescript public readonly repository: string; ``` - *Type:* string Additional metadata. --- ##### `tag`^Optional ```typescript public readonly tag: string; ``` - *Type:* string Optional git tag information. --- ### IVersioningStrategy - *Implemented By:* VersioningStrategy, IVersioningStrategy #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | components | VersioningStrategyComponents | Components to include. | | format | string | Version format template Variables: {git-tag}, {package-version}, {commit-count}, {commit-hash}, {commit-hash:8}, {branch}, {build-number}. | --- ##### `components`^Required ```typescript public readonly components: VersioningStrategyComponents; ``` - *Type:* VersioningStrategyComponents Components to include. --- ##### `format`^Required ```typescript public readonly format: string; ``` - *Type:* string Version format template Variables: {git-tag}, {package-version}, {commit-count}, {commit-hash}, {commit-hash:8}, {branch}, {build-number}. --- ## Enums ### CdkDiffType #### Members | **Name** | **Description** | | --- | --- | | NONE | Do not perform a diff. | | FAST | Perform a fast template diff (--no-changeset). | | FULL | Perform a full CloudFormation diff (--changeset). | --- ##### `NONE` Do not perform a diff. --- ##### `FAST` Perform a fast template diff (--no-changeset). --- ##### `FULL` Perform a full CloudFormation diff (--changeset). --- ### PipelineEngine The CI/CD tooling used to run your pipeline. The component will render workflows for the given system #### Members | **Name** | **Description** | | --- | --- | | GITHUB | Create GitHub actions. | | GITLAB | Create a .gitlab-ci.yaml file. | | BASH | Create bash scripts. | --- ##### `GITHUB` Create GitHub actions. --- ##### `GITLAB` Create a .gitlab-ci.yaml file. --- ##### `BASH` Create bash scripts. ---