Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit f1c8542

Browse filesBrowse files
authored
docs: rework readme (#78)
1 parent 2d73ef8 commit f1c8542
Copy full SHA for f1c8542

File tree

Expand file treeCollapse file tree

2 files changed

+3
-21
lines changed
Filter options
Expand file treeCollapse file tree

2 files changed

+3
-21
lines changed

‎.github/aws-codedeploy-action.png

Copy file name to clipboard
150 KB
Loading

‎README.md

Copy file name to clipboardExpand all lines: README.md
+3-21Lines changed: 3 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# AWS CodeDeploy Action
2+
_To automatically deploy applications to EC2 via CodeDeploy._
23

3-
To automatically deploy applications to EC2 via CodeDeploy.
4+
![](.github/aws-codedeploy-action.png)
45

56
---
67

@@ -79,7 +80,7 @@ Following inputs can be used as `step.with` keys
7980
| `max_polling_iterations` | No | Number | Number of 15s iterations to poll max. (default: `60`) |
8081
| `dry_run` | No | Boolean | If true, no connection to AWS is made. Just local zip creation. |
8182

82-
## Skipping waiting during deployment
83+
## Skip waiting during deployment
8384
Some projects may not want to poll for a completion of a build. Setting `max_polling_iterations` to `0` will exit
8485
the script after the deployment was kicked off. Progress will have to be monitored elsewhere.
8586

@@ -92,7 +93,6 @@ Some projects may have a complex build system or even build the archive in a pre
9293
* `archive` must be zip filename including extension (ie `prod-backend-20220202.zip`).
9394

9495
## IAM Permissions
95-
_If using manual Access/Secret keys_
9696

9797
You shouldn't be using a root user. Below are snippets of an inline policies with suggested permissions for the action.
9898

@@ -153,21 +153,3 @@ For deploying via CodeDeploy you will need another set of permissions.
153153

154154
* These permissions are a rough example of allowing the user to list/get/register a revision for all resources
155155
* A specific permission statement exists to lock creating the deployment to a specific resource
156-
157-
---
158-
159-
### Install as Local Action
160-
161-
For quicker troubleshooting cycles, the action can be copied directly into another project. This way, changes to the
162-
action, and its usage can happen simultaneously in one commit.
163-
164-
1. Copy this repository into your other project as `.github/actions/aws-codedeploy-action`. Be careful: simply cloning
165-
in place will likely install it as a submodule--make sure to copy the files without `.git`
166-
1. As a single command:
167-
```shell
168-
mkdir .github/actions && \
169-
git clone --depth=1 --branch=master git@github.com:sourcetoad/aws-codedeploy-action.git .github/actions/aws-codedeploy-action && \
170-
rm -rf .github/actions/aws-codedeploy-action/.git
171-
```
172-
2. In your other project's workflow, in the action step, set
173-
`uses: ./.github/actions/aws-codedeploy-action`

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.