Document behaviour of capacity-provider-strategy

- Add attribution for improvements

Author: muya

README.md

@@ -1,6 +1,15 @@
 ## Amazon ECS "Run Task" Action for GitHub Actions
 
-Runs an Amazon ECS task on ECS cluster.
+Runs an Amazon ECS task on ECS cluster, with options for Launch Type, VPC Configuration & Capacity Provider Strategy.
+
+Combines improvements from the following repositories and PRs:
+
+- [Add support for capacity provider strategy attribute by @evgeniy-b](https://github.com/smitp/amazon-ecs-run-task/pull/76/files) - 
+  to add support for [capacity provider strategy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html?icmpid=docs_ecs_hp_deploy).
+- [YashdalfTheGray/amazon-ecs-run-task](https://github.com/YashdalfTheGray/amazon-ecs-run-task/) - to add support
+  for `launchType` and `networkConfiguration`
+- [smitp/amazon-ecs-run-task](https://github.com/smitp/amazon-ecs-run-task) - initial fork which enabled running of an
+  ECS task
 
 **Table of Contents**
 
@@ -21,7 +30,7 @@ Runs an Amazon ECS task on ECS cluster.
 
 ```yaml
     - name: Run Task on Amazon ECS
-      uses: muya/amazon-ecs-run-task
+      uses: muya/amazon-ecs-run-task@v1
       with:
         task-definition: task-definition.json
         cluster: my-cluster
@@ -95,7 +104,7 @@ The task definition file can be updated prior to deployment with the new contain
         image: ${{ steps.build-image.outputs.image }}
 
     - name: Run Task on Amazon ECS
-      uses: muya/amazon-ecs-run-task
+      uses: muya/amazon-ecs-run-task@v1
       with:
         task-definition: task-definition.json
         cluster: my-cluster

action.yml

@@ -23,19 +23,29 @@ inputs:
     description: 'How long to wait for the task reach stopped state, in minutes (default: 30 minutes, max: 6 hours).'
     required: false
   launch-type:
-    description: The launch type of the task, either FARGATE or EC2
+    description: The launch type of the task, either FARGATE or EC2. Can be overridden by the capacity-provider-strategy.
     required: false
   capacity-provider-strategy:
-    description: 'JSON representation of the capacity provider strategy to use for the task. Only set if provided. Example: [{"capacityProvider": "FARGATE_SPOT", "base": 0, "weight": 1}]. Provider options: [FARGATE, FARGATE_SPOT]'
+    description: |
+      JSON representation of the capacity provider strategy to use for the task. Only set if provided. 
+      Example: '[{"capacityProvider": "FARGATE_SPOT", "base": 0, "weight": 1}]'. 
+      Provider options: [FARGATE, FARGATE_SPOT].
+      Overrides value of launch-type if set.
     required: false
   subnets:
-    description: The subnets to launch a FARGATE tasks in, required if launch type is FARGATE and is expected in CSV format
+    description: |
+      The subnets to launch a FARGATE tasks in, required if launch type is FARGATE and is expected in CSV format. 
+      Only applies if either "launch-type" or "capacity-provider-strategy" is set.
     required: false
   security-groups:
-    description: The security groups to associate a FARGATE task with, required if launch type is FARGATE and is expected in CSV format
+    description: |
+      The security groups to associate a FARGATE task with, required if launch type is FARGATE and is expected in CSV format.
+      Only applies if either "launch-type" or "capacity-provider-strategy" is set.
     required: false
   assign-public-ip:
-    description: Whether to assign a public IP to the FARGATE task or not, required if launch type is FARGATE. Should be one of [DISABLED,ENABLED]
+    description: |
+      Whether to assign a public IP to the FARGATE task or not, required if launch type is FARGATE. 
+      Should be one of [DISABLED,ENABLED]. Defaults to DISABLED
     required: false
   task-role-override:
     description: A role ARN for task permissions so that a role ARN is not hardcoded within the task definition