github-action-run-ecspresso/README.yaml at main · cloudposse/github-action-run-ecspresso · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: github-action-run-ecspresso

# Tags of this project
tags:
  - github-action

# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"

# Canonical GitHub repo
github_repo: cloudposse/github-action-run-ecspresso

# Badges to display
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/github-action-run-ecspresso.svg?style=for-the-badge
    url: https://github.com/cloudposse/github-action-run-ecspresso/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/github-action-run-ecspresso.svg?style=for-the-badge
    url: https://github.com/cloudposse/github-action-run-ecspresso/commits
  - name: Slack Community
    image: https://slack.cloudposse.com/for-the-badge.svg
    url: https://cloudposse.com/slack

# List any related terraform modules that this module may be used with or that this module depends on.
related: []

# Short description of this project
description: Run ECS task with [Escpresso](https://github.com/kayac/ecspresso)

introduction: |-
  This is template repository to create composite GitHub Actions.
  Feel free to use it as reference and starting point.

references:
  - name: "github-actions-workflows"
    description: "Reusable workflows for different types of projects"
    url: "https://github.com/cloudposse/github-actions-workflows"
  - name: "example-github-action-release-workflow"
    description: "Example application with complicated release workflow"
    url: "https://github.com/cloudposse/example-github-action-release-workflow"

# How to use this project
usage: |-
  ```yaml
    name: Pull Request
    on:
      push:
        branches: [ 'main' ]

    jobs:
      context:
        runs-on: ubuntu-latest
        steps:
          - name: Example action
            uses: cloudposse/example-github-action-run-ecspresso@main
            id: example
            with:
              image: 1111111111111.dkr.ecr.us-east-2.amazonaws.com/cloudposse/example-app-on-ecs
              image-tag: latest
              region: us-east-2
              operation: deploy
              cluster: acme-plat-ue2-sandbox
              application: acme-plat-ue2-sandbox-example-app-on-ecs
              taskdef-path: taskdef.json
              overrides: |-
                {
                  "containerOverrides":[
                    {
                      "name": "app",
                      "command": ["/db-migrate.sh"]
                    }
                  ]
                }

        outputs:
          result: ${{ steps.example.outputs.webapp-url }}
  ```

include: []
contributors: []