diff --git a/README.md b/README.md index 075124e..76785de 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,11 @@ The purpose of this repository is to provide a GitHub Action to scale down an ECS service's desired count to zero. -This action leverages the aws-actions/configure-aws-credentials action. Since GitHub Actions currently does not allow composite actions to call other actions, we chose to integrate the JavaScript code from existing aws-actions into this repository. +This action leverages the + aws-actions/configure-aws-credentials action. + Since GitHub Actions currently does not allow + composite actions to call other actions, + we chose to integrate the JavaScript code from existing aws-actions into this repository. ## What it does @@ -20,8 +24,11 @@ No modifications made. the `index.js` and `cleanup.js` files from ## Use Case and Usage -This action was developed as a way to scale down an ECS Service after the tasks no longer need to be run. -Specifically, this is designed to work following a workflow using Self-Hosted GitHub Runners that are stood up by the [trussworks/ecs-scaleup](https://github.com/trussworks/ecs-scaleup) action. +This action was developed as a way to scale down + an ECS Service after the tasks no longer need to be run. +Specifically, this is designed to work following a workflow using + Self-Hosted GitHub Runners that are stood up by + the [trussworks/ecs-scaleup](https://github.com/trussworks/ecs-scaleup) action. ```yaml ecs-scaledown: @@ -39,4 +46,7 @@ ecs-scaledown: cluster: github-runner ``` -**NOTE**: When using this to deprovision Self-Hosted GitHub runners, you must populate the `needs` argument in the YAML above with all jobs that are using self-hosted runners. To do this, replace ALL_OTHER_JOBS with a list of jobs denoted by name. \ No newline at end of file +**NOTE**: When using this to deprovision Self-Hosted GitHub runners, + you must populate the `needs` argument in the YAML above with + all jobs that are using self-hosted runners. + To do this, replace ALL_OTHER_JOBS with a list of jobs denoted by name.