Merge branch 'master' into corymhall/integ-tests/internal

aws · May 23, 2022 · 7303172 · 7303172
2 parents 51b1907 + e9cbda3
commit 7303172
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 20 deletions.
diff --git a/packages/@aws-cdk/aws-s3/README.md b/packages/@aws-cdk/aws-s3/README.md
@@ -522,15 +522,15 @@ by deploying with CDK version `1.126.0` or later **before** switching this value
 
 ```ts
 const bucket = new s3.Bucket(this, 'MyBucket', {
-   transferAcceleration: true,
+  transferAcceleration: true,
 });
 ```
 
 To access the bucket that is enabled for Transfer Acceleration, you must use a special endpoint. The URL can be generated using method `transferAccelerationUrlForObject`:
 
 ```ts
 const bucket = new s3.Bucket(this, 'MyBucket', {
-   transferAcceleration: true,
+  transferAcceleration: true,
 });
 bucket.transferAccelerationUrlForObject('objectname');
 ```
@@ -540,14 +540,14 @@ bucket.transferAccelerationUrlForObject('objectname');
 [Intelligent Tiering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intelligent-tiering.html) can be configured to automatically move files to glacier:
 
 ```ts
-    new s3.Bucket(this, 'MyBucket', {
-   intelligentTieringConfigurations: [{
-      name: 'foo',
-      prefix: 'folder/name',
-      archiveAccessTierTime: cdk.Duration.days(90),
-      deepArchiveAccessTierTime: cdk.Duration.days(180),
-      tags: [{key: 'tagname', value: 'tagvalue'}]
-   }],
+new s3.Bucket(this, 'MyBucket', {
+  intelligentTieringConfigurations: [{
+    name: 'foo',
+    prefix: 'folder/name',
+    archiveAccessTierTime: cdk.Duration.days(90),
+    deepArchiveAccessTierTime: cdk.Duration.days(180),
+    tags: [{key: 'tagname', value: 'tagvalue'}]
+  }],
 });
 
 ```

diff --git a/packages/@aws-cdk/pipelines/lib/codepipeline/codepipeline-source.ts b/packages/@aws-cdk/pipelines/lib/codepipeline/codepipeline-source.ts
@@ -38,6 +38,9 @@ export abstract class CodePipelineSource extends Step implements ICodePipelineAc
    *
    * * **repo** - to read the repository
    * * **admin:repo_hook** - if you plan to use webhooks (true by default)
+   *
+   * If you need access to symlinks or the repository history, use a source of type
+   * `connection` instead.
    */
   public static gitHub(repoString: string, branch: string, props: GitHubSourceOptions = {}): CodePipelineSource {
     return new GitHubSource(repoString, branch, props);
@@ -92,6 +95,9 @@ export abstract class CodePipelineSource extends Step implements ICodePipelineAc
    * });
    * ```
    *
+   * If you need access to symlinks or the repository history, be sure to set
+   * `codeBuildCloneOutput`.
+   *
    * @param repoString A string that encodes owner and repository separated by a slash (e.g. 'owner/repo').
    * @param branch The branch to use.
    * @param props The source properties, including the connection ARN.
@@ -105,6 +111,10 @@ export abstract class CodePipelineSource extends Step implements ICodePipelineAc
   /**
    * Returns a CodeCommit source.
    *
+   * If you need access to symlinks or the repository history, be sure to set
+   * `codeBuildCloneOutput`.
+   *
+   *
    * @param repository The CodeCommit repository.
    * @param branch The branch to use.
    * @param props The source properties.
@@ -360,12 +370,12 @@ export interface ConnectionSourceOptions {
 
   // long URL in @see
   /**
-   * Whether the output should be the contents of the repository
-   * (which is the default),
-   * or a link that allows CodeBuild to clone the repository before building.
+   * If this is set, the next CodeBuild job clones the repository (instead of CodePipeline downloading the files).
+   *
+   * This provides access to repository history, and retains symlinks (symlinks would otherwise be
+   * removed by CodePipeline).
    *
-   * **Note**: if this option is true,
-   * then only CodeBuild actions can use the resulting {@link output}.
+   * **Note**: if this option is true, only CodeBuild jobs can use the output artifact.
    *
    * @default false
    * @see https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodestarConnectionSource.html#action-reference-CodestarConnectionSource-config
@@ -435,12 +445,12 @@ export interface CodeCommitSourceOptions {
   readonly eventRole?: iam.IRole;
 
   /**
-   * Whether the output should be the contents of the repository
-   * (which is the default),
-   * or a link that allows CodeBuild to clone the repository before building.
+   * If this is set, the next CodeBuild job clones the repository (instead of CodePipeline downloading the files).
+   *
+   * This provides access to repository history, and retains symlinks (symlinks would otherwise be
+   * removed by CodePipeline).
    *
-   * **Note**: if this option is true,
-   * then only CodeBuild actions can use the resulting {@link output}.
+   * **Note**: if this option is true, only CodeBuild jobs can use the output artifact.
    *
    * @default false
    * @see https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodeCommit.html