Skip to content

Commit

Permalink
chore: update readme and default value
Browse files Browse the repository at this point in the history
  • Loading branch information
Mgonand committed Oct 16, 2023
1 parent 3406e1f commit df533a6
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 7 deletions.
37 changes: 31 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,23 @@
<!-- start title --># GitHub Action: BinPar Deploy ECS Service Action for GitHub Actions<!-- end title -->
<!-- start description -->Registers an Amazon ECS task definition, and deploys it to a service, but with more custom options than the official AWS GitHub Action.<!-- end description -->
<!-- start title -->

# GitHub Action: BinPar Deploy ECS Service Action for GitHub Actions

<!-- end title -->

<!-- start description -->

Registers an Amazon ECS task definition, and deploys it to a service, but with more custom options than the official AWS GitHub Action.

<!-- end description -->

<!-- start contents -->


<!-- end contents -->
<!-- start usage -->```yaml

<!-- start usage -->

```yaml

- uses: BinPar/deploy-ecs-service@v1.0.0
with:
Expand All @@ -25,20 +40,30 @@
force-new-deploy: ''

```

<!-- end usage -->
<!-- start inputs -->| ****Input**** | ****Description**** | ****Default**** | ****Required**** |

<!-- start inputs -->

| ****Input**** | ****Description**** | ****Default**** | ****Required**** |
|---|---|---|---|
| `**task-definition**` | The path to the ECS task definition file to register. | | **true** |
| `**services-definition**` | The path to the YAML with the services definition. | | **true** |
| `**region**` | The AWS region to use. | | __false__ |
| `**wait-for-service-stability**` | Wait for the service to be stable before continuing. | | __false__ |
| `**wait-for-minutes**` | The number of minutes to wait for the service to be stable. | `10` | __false__ |
| `**force-new-deploy**` | Force a new deployment of the service. | | __false__ |

<!-- end inputs -->
<!-- start outputs -->| ****Output**** | ****Description**** |

<!-- start outputs -->

| ****Output**** | ****Description**** |
|---|---|
| `**task-definition-arn**` | The ARN of the task definition. |

<!-- end outputs -->

<!-- start [.github/ghadocs/examples/] -->

<!-- end [.github/ghadocs/examples/] -->
```
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ inputs:
force-new-deploy:
description: 'Force a new deployment of the service.'
required: false
default: false
default: true

# Define your outputs here.
outputs:
Expand Down

0 comments on commit df533a6

Please sign in to comment.