Skip to content

Commit cdaa771

Browse files
committed
Cleanup docs
1 parent 67d8112 commit cdaa771

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,6 @@ Registers an Amazon ECS task definition and deploys it to an ECS service.
2020

2121
## Usage
2222

23-
The action supports the following inputs:
24-
25-
* `task-definition` (required) - The path to the ECS task definition file (JSON format) to register.
26-
* `max-retries` (optional) - The maximum number of retry attempts for AWS API calls. The action uses exponential backoff with jitter for retries. Defaults to 3.
27-
* `service` (optional) - The name of the ECS service to update with the new task definition. If empty, the action will not attempt to update a service.
28-
2923
```yaml
3024
- name: Deploy to Amazon ECS
3125
uses: aws-actions/amazon-ecs-deploy-task-definition@v2
@@ -234,7 +228,7 @@ Running a service requires the following minimum set of permissions:
234228
]
235229
}
236230
```
237-
231+
238232
Running a one-off/stand-alone task requires the following minimum set of permissions:
239233
```json
240234
{
@@ -348,7 +342,7 @@ In the following example, the service would not be updated until the ad-hoc task
348342
wait-for-task-stopped: true
349343
```
350344

351-
Overrides and VPC networking options are available as well. See [action.yml](action.yml) for more details. The `FARGATE`
345+
Overrides and VPC networking options are available as well. See [action.yml](action.yml) for more details. The `FARGATE`
352346
launch type requires `awsvpc` network mode in your task definition and you must specify a network configuration.
353347

354348
### Tags
@@ -372,6 +366,21 @@ To tag your tasks:
372366
wait-for-task-stopped: true
373367
```
374368

369+
### Retries
370+
371+
To retry a deployment of a task definition use `max-retries`. The default value is `3`.
372+
373+
```yaml
374+
- name: Deploy to Amazon ECS
375+
uses: aws-actions/amazon-ecs-deploy-task-definition@v2
376+
with:
377+
task-definition: task-definition.json
378+
service: my-service
379+
cluster: my-cluster
380+
max-retries: 5
381+
wait-for-service-stability: true
382+
```
383+
375384
## Troubleshooting
376385

377386
This action emits debug logs to help troubleshoot deployment failures. To see the debug logs, create a secret named `ACTIONS_STEP_DEBUG` with value `true` in your repository.

0 commit comments

Comments
 (0)