github-action-deploy-spacelift/README.yaml at main · cloudposse/github-action-deploy-spacelift · 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
91
92
93
94
95
96
97
98
99
100
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: github-action-deploy-spacelift

# 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-deploy-spacelift

# Badges to display
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/github-action-deploy-spacelift.svg?style=for-the-badge
    url: https://github.com/cloudposse/github-action-deploy-spacelift/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/github-action-deploy-spacelift.svg?style=for-the-badge
    url: https://github.com/cloudposse/github-action-deploy-spacelift/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:
  - name: "github-action-deploy-helmfile"
    description: "Deploy on Kubernetes with Helmfile"
    url: "https://github.com/cloudposse/github-action-deploy-helmfile"
  - name: "github-action-spacelift-stack-deploy"
    description: "Deploy Spacelift Stack"
    url: "https://github.com/cloudposse/github-action-spacelift-stack-deploy"

# Short description of this project
description: Opinionated way to deploy Docker image app with Spacelift

introduction: |-
  Set Docker image uri into SSM parameter store and trigger Spacelift stack that should handle deployment.

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:
      pull_request:
        branches: [ 'main' ]
        types: [opened, synchronize, reopened, closed, labeled, unlabeled]

    jobs:
      deploy:
        runs-on: ubuntu-latest
        environment:
          name: production
          url: ${{ steps.deploy.outputs.webapp-url }}
        steps:
          - name: Configure AWS Credentials
            uses: aws-actions/configure-aws-credentials@v1.7.0
            with:
              aws-region: us-west-2
              role-to-assume: arn:aws:iam::123456789012:role/AllowWriteSSM

          - name: Deploy
            uses: cloudposse/github-action-deploy-spacelift@main
            id: deploy
            with:
              stack: ecs-service-production
              region: us-west-2
              ssm-path: /ecs-service/image
              image: nginx
              image-tag: latest
              operation: deploy
              debug: false
              github_token: ${{ secrets.GITHUB_TOKEN }}
              organization: acme
              api_key_id: ${{ secrets.SPACELIFT_API_KEY_ID }}
              api_key_secret: ${{ secrets.SPACELIFT_API_KEY_SECRET }}

        outputs:
          url: ${{ steps.deploy.outputs.webapp-url }}
  ```

include: []
contributors: []