@flit/cdk-pipeline 1.2.0 → 1.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flit/cdk-pipeline",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "A highly customizable and extensible CI/CD pipeline intended as alternative to CDK's native CodePipeline",
   "keywords": [
     "aws",

package/src/code-commit-source-segment.ts

@@ -32,7 +32,7 @@ export class CodeCommitSourceSegment extends SourceSegment {
       this.props.repository.repositoryName,
       {
         ...this.props,
-        actionName: this.props.repository.repositoryName,
+        actionName: `${this.props.repository}/${this.props.branch || "master"}`,
       },
     );
   }

package/src/code-star-source-segment.ts

@@ -7,9 +7,27 @@ import { SegmentConstructed } from "./segment";
 import { SourceSegment, SourceSegmentProps } from "./source-segment";
 
 export interface CodeStarSourceSegmentProps extends SourceSegmentProps {
+  /**
+   * The owning user or organization of the repository.
+   * @example `"aws"`
+   */
   readonly owner: string;
+  /**
+   * The ARN of the CodeStar Connection created in the AWS console
+   * that has permissions to access this GitHub or BitBucket repository.
+   * @example `"arn:aws:codestar-connections:us-east-1:123456789012:connection/12345678-abcd-12ab-34cdef5678gh"`
+   * @see https://docs.aws.amazon.com/codepipeline/latest/userguide/connections-create.html
+   */
   readonly connectionArn: string;
+  /**
+   * The name of the repository.
+   * @example `"aws-cdk"`
+   */
   readonly repository: string;
+  /**
+   * The branch to build.
+   * @default `"master"`
+   */
   readonly branch?: string;
   readonly triggerOnPush?: boolean;
   readonly variablesNamespace?: string;
@@ -27,7 +45,9 @@ export class CodeStarSourceSegment extends SourceSegment {
   construct(scope: Pipeline): SegmentConstructed {
     return new CodeStarSourceSegmentConstructed(scope, this.props.repository, {
       ...this.props,
-      actionName: this.props.repository,
+      actionName: `${this.props.owner}/${this.props.repository}/${
+        this.props.branch || "master"
+      }`,
       repo: this.props.repository,
     });
   }

package/src/git-hub-source-segment.ts

@@ -12,8 +12,20 @@ import { SourceSegment, SourceSegmentProps } from "./source-segment";
 
 export interface GitHubSourceSegmentProps extends SourceSegmentProps {
   readonly oauthToken: SecretValue;
+  /**
+   * The owning user or organization of the repository.
+   * @example `"aws"`
+   */
   readonly owner: string;
+  /**
+   * The name of the repository.
+   * @example `"aws-cdk"`
+   */
   readonly repository: string;
+  /**
+   * The branch to build.
+   * @default `"master"`
+   */
   readonly branch?: string;
   readonly trigger?: GitHubTrigger;
   readonly variablesNamespace?: string;
@@ -31,7 +43,9 @@ export class GitHubSourceSegment extends SourceSegment {
   construct(scope: Pipeline): SegmentConstructed {
     return new GitHubSourceSegmentConstructed(scope, this.props.repository, {
       ...this.props,
-      actionName: this.props.repository,
+      actionName: `${this.props.owner}/${this.props.repository}/${
+        this.props.branch || "master"
+      }`,
       repo: this.props.repository,
     });
   }

package/src/pipeline-segment.ts

@@ -36,7 +36,7 @@ export interface PipelineSegmentProps {
   readonly environmentVariables?: { [key: string]: BuildEnvironmentVariable };
   /**
    * The name of the stack to apply this action to.
-   * @deafult The name of the given stack.
+   * @default The name of the given stack.
    */
   readonly stackName?: string;
   /**

package/src/pipeline.ts

@@ -14,13 +14,13 @@ import { isPipeline } from "./pipeline-segment";
 export interface PipelineProps extends StackProps {
   /**
    * The name of the generated pipeline.
-   * @defaultValue Stack ID
+   * @default Stack ID
    */
   readonly pipelineName?: string;
   /**
    * The path to the cdk projects root directory containing the cdk.json file
    * relative to the asset root
-   * @defaultValue `"."`
+   * @default `"."`
    */
   readonly rootDir?: string;
   /**

package/src/s3-source-segment.ts

@@ -31,7 +31,7 @@ export class S3SourceSegment extends SourceSegment {
   construct(scope: Pipeline): SegmentConstructed {
     return new S3SourceSegmentConstructed(scope, this.props.bucket.bucketName, {
       ...this.props,
-      actionName: this.props.bucket.bucketName,
+      actionName: `${this.props.bucket}/${this.props.bucketKey}`,
     });
   }
 }

package/src/stack-segment.ts

@@ -45,7 +45,7 @@ export interface StackSegmentProps {
   readonly environmentVariables?: { [key: string]: BuildEnvironmentVariable };
   /**
    * The name of the stack to deploy the changes to.
-   * @defaultValue The name of the given stack.
+   * @default The name of the given stack.
    */
   readonly stackName?: string;
   /**
@@ -54,12 +54,12 @@ export interface StackSegmentProps {
   readonly output?: Artifact;
   /**
    * The filename for the file in the output artifact
-   * @defaultValue `"artifact.json"``
+   * @default `"artifact.json"`
    */
   readonly outputFileName?: string;
   /**
    * Does this stage require manual approval of the change set?
-   * @defaultValue `false``
+   * @default `false`
    */
   readonly manualApproval?: Boolean;
 }