Create README.md

railsware · Jul 3, 2020 · 87f5164 · 87f5164
1 parent 760a053
commit 87f5164
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/fetch-task-definition/README.md b/fetch-task-definition/README.md
@@ -0,0 +1,15 @@
+# fetch-task-definition
+
+Fetch task definition from ECS (to use with [aws-actions/amazon-ecs-render-task-definition](https://github.com/aws-actions/amazon-ecs-render-task-definition)).
+
+Make sure to provide AWS credentials through the environment: `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_REGION`
+
+```yml
+- uses: railsware/github-actions/fetch-task-definition@master
+  with:
+    name: my_task_definition_name
+    # Default filename is task_definition.json
+    filename: my_task_definition.json
+```
+
+