|
5 | 5 | [](https://www.npmjs.com/package/aws-code-deploy)
|
6 | 6 | [](https://raw.githubusercontent.com/techpivot/phalcon-ci-installer/master/LICENSE)
|
7 | 7 |
|
8 |
| - |
9 |
| -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 |
10 |
| -the [AWS CLI API](http://docs.aws.amazon.com/cli/latest/reference/deploy/index.html). |
| 8 | +This script deploys applications with the [AWS Code Deploy](http://docs.aws.amazon.com/codedeploy/latest/userguide/welcome.html) service. The script uses the AWS CLI for underlying commands and extends functionality to provide common requirements for applications being deployed including compression, encryption, bucket revision limiting, monitoring, and more. It also handles creation of defined AWS Code Deploy components as necessary (e.g. Deployment Groups). By utilizing environment variables, this script is easily portable and intended to run inside CI containers. For more information, refer to the [AWS Code Deploy](http://docs.aws.amazon.com/codedeploy/latest/userguide/welcome.html) documentation or the [AWS CLI API](http://docs.aws.amazon.com/cli/latest/reference/deploy/index.html). |
11 | 9 |
|
12 | 10 | ### Features:
|
13 |
| - * Minimal dependencies: aws (If not installed automatically installed) |
14 |
| - * Compression of source contents |
| 11 | + * One dependency: AWS CLI (Automatically installed if not available) |
| 12 | + * Automatically compress source directory |
15 | 13 | * Ability to limit the number of stored revisions by a key prefix to help reduce S3 total file size
|
16 | 14 | * Server side encryption for revisions
|
17 | 15 | * Full diagnostic output from failed instances
|
@@ -79,25 +77,41 @@ Status | In Progress: 0 | Pending: 0 | Skipped: 0 | Succeeded: 1 | Failed:
|
79 | 77 | ```
|
80 | 78 |
|
81 | 79 |
|
82 |
| -## How to Include In Your Project |
| 80 | +## Usage |
83 | 81 |
|
84 |
| -### Composer (For PHP Projects) |
85 |
| -1. Include in `composer.json` as follows: |
| 82 | +### Composer (PHP Projects) |
| 83 | +1. Include the `techpivot/aws-code-deploy` project from Packagist as a development dependency: |
86 | 84 |
|
| 85 | + **composer.json** |
87 | 86 | ```json
|
88 | 87 | "require-dev" : {
|
89 | 88 | "techpivot/aws-code-deploy": "~1.0"
|
90 | 89 | }
|
91 | 90 | ```
|
92 |
| - * The file can then be executed from the /vendor/bin directory: `bash vendor/bin/aws-code-deploy.sh` |
| 91 | + |
| 92 | + or via command line: |
| 93 | + |
| 94 | + ```bash |
| 95 | + composer require --dev techpivot/aws-code-deploy ~1.0 |
| 96 | + ``` |
| 97 | + |
| 98 | +2. The file can then be executed directly: `./vendor/bin/aws-code-deploy.sh` |
93 | 99 |
|
94 | 100 | ### NPM (General Projects)
|
| 101 | +Include the `aws-code-deploy` from NPM as a local or global dependency. |
| 102 | + |
| 103 | +#### **Global** |
| 104 | +1. `npm install aws-code-deploy -g` |
| 105 | +2. The file can then be executed directly: `aws-code-deploy` |
| 106 | + |
| 107 | +#### **Local** |
| 108 | +1. `npm install aws-code-deploy` |
| 109 | +2. The file can then be executed directly: `./node_modules/aws-code-deploy/bin/aws-code-deploy.sh` |
95 | 110 |
|
96 | 111 |
|
97 | 112 | ## Environment Variables
|
98 | 113 |
|
99 |
| -Brief summary is listed in the table below. Full descriptions with recommendations can be found by searching |
100 |
| -the readme for the variable name. |
| 114 | +Environment variables are used to control the deployment actions. A brief summary is listed in the table below. Full descriptions with recommendations can be found by searching the readme for the variable name. |
101 | 115 |
|
102 | 116 | | Variable | Required | Description |
|
103 | 117 | | :---------------------------------------- | :------- | :----------------------------------------------------------|
|
@@ -160,11 +174,6 @@ deployment:
|
160 | 174 | - bash vendor/bin/aws-code-deploy.sh
|
161 | 175 | ```
|
162 | 176 |
|
163 |
| -### TravisCI |
164 |
| -
|
165 |
| -### Manual |
166 |
| -
|
167 |
| -
|
168 | 177 | ## IAM Requirements
|
169 | 178 |
|
170 | 179 | In order for the script to execute successfully, the specified AWS credentials must be granted the required
|
|
0 commit comments