Skip to content

Commit b265ce4

Browse files
committed
Update README.md
1 parent a9f3cbb commit b265ce4

File tree

1 file changed

+24
-7
lines changed

1 file changed

+24
-7
lines changed

README.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,34 @@
1-
Wercker step for AWS Code Deploy
2-
=======================
1+
# AWS Code Deploy Executer
32

4-
[![wercker status](https://app.wercker.com/status/3810984a0833d6af679f0609bd3e18be/m "wercker status")](https://app.wercker.com/project/bykey/3810984a0833d6af679f0609bd3e18be)
3+
This script deploys applications with the [AWS Code Deploy](http://docs.aws.amazon.com/codedeploy/latest/userguide/welcome.html) service. This script has been adapted to be easily portable and configurable via environment variables such that it can be incorporated within CI services that do not natively include support for Code Deploy. Additionally, this script includes additional functionality described below that is typically not included in out-of-box Code Deploy CI systems. For more information, refer to the [AWS Code Deploy](http://docs.aws.amazon.com/codedeploy/latest/userguide/welcome.html) documentation or
4+
the [AWS CLI API](http://docs.aws.amazon.com/cli/latest/reference/deploy/index.html).
55

6-
This wercker step allows to deploy applications with [AWS Code Deploy](http://docs.aws.amazon.com/codedeploy/latest/userguide/welcome.html) service.
6+
Features:
7+
* Compression of source contents
8+
* Ability to limit the number of stored revisions by a key prefix to help reduce S3 total file size
9+
* Server side encryption for revisions
10+
* Full diagnostic output from failed instances
711

8-
Please read the [AWS Code Deploy](http://docs.aws.amazon.com/codedeploy/latest/userguide/welcome.html) documentation and [API](http://docs.aws.amazon.com/cli/latest/reference/deploy/index.html) before using this step.
12+
Operating Systems Supported:
13+
* Debian
14+
* Ubuntu 14.04
915

1016

11-
The step install the [AWS Cli](http://docs.aws.amazon.com/cli/latest/userguide/installing.html) through pip, if the CLI is not already installed.
17+
## How to Include In Your Proect
1218

19+
#### 1. Via Composer (For PHP Projects)
1320

14-
## AWS Code Deploy workflow
21+
#### 2. Git Submodule
22+
23+
#### 3. Git Subtree
24+
25+
26+
## Usage
27+
28+
29+
30+
31+
## AWS Code Deploy Workflow
1532

1633
To deploy an application with AWS Code Deploy, the Wercker step follow this steps :
1734

0 commit comments

Comments
 (0)