Add description and comments

aahung · Jun 21, 2021 · 7ecdd30 · 7ecdd30
1 parent b2695e1
commit 7ecdd30
Showing 1 changed file with 31 additions and 0 deletions.
diff --git a/codepipeline.yaml b/codepipeline.yaml
@@ -1,4 +1,35 @@
 AWSTemplateFormatVersion : '2010-09-09'
+Description: >
+  This template deploys a CodePipiline with its required resources.
+  It uses AWS CodeStar Connections to connect the pipeline to git repository.
+
+  The following stages are predefined in this template:
+  - Source
+  - UpdatePipeline
+  - BuildAndDeployFeatureStack (FeatureGitBranch only)
+  - BuildAndPackage (MainGitBranch only)
+  - DeployTest (MainGitBranch only)
+  - DeployProd (MainGitBranch only)
+
+  **WARNING** You will be billed for the AWS resources used if you create a stack from this template.
+
+
+# To deploy this template and connect to the main git branch, run
+# `sam deploy -t codepipeline.yaml --stack-name <stack-name> --capabilities=CAPABILITY_IAM`
+# (replace "<stack-name>" with the name of the AWS CloudFormation stack that you're deploying to).
+
+# After creating the stack, the CodeStar Connection is in PENDING status by default. You must complete 
+# the OAuth handshake with the third-party provider using the installation associated with your connection.
+# See https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-update.html for instructions.
+
+# If later you need to deploy a new CodePipeline to connect to a non-main git branch, run
+# ```
+# sam deploy -t codepipeline.yaml --stack-name <stack-name> --capabilities=CAPABILITY_IAM \
+#   --parameter-overrides="FeatureGitBranch=<branch-name> CodeStarConnectionArn=<codestar-connection-arn>
+# ```
+# (replace "<stack-name>" with the name of the AWS CloudFormation stack that you're deploying to,
+# "<branch-name>" with the branch name and "<codestar-connection-arn>" with the CodeStar Connection ARN which
+# can be found in the first pipeline stack's output.)
 
 Parameters:
   CodeStarConnectionProviderType: