README.yaml

---
#
# 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-helmfile

# 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-helmfile

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/cloudposse/github-action-deploy-helmfile.svg"
    url: "https://github.com/cloudposse/github-action-deploy-helmfile/releases/latest"
  - name: "Slack Community"
    image: "https://slack.cloudposse.com/badge.svg"
    url: "https://slack.cloudposse.com"

related: []

# Short description of this project
description: Deploy on Kubernetes with HelmFile

introduction: |-
  Deploy on Kubernetes with HelmFile. 

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: |-
  Deploy environment
  ```yaml
    name: Pull Request
    on:
      pull_request:
        branches: [ 'main' ]
        types: [opened, synchronize, reopened]

    jobs:
      deploy:
        runs-on: ubuntu-latest
        environment:
          name: preview
          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::111111111111:role/preview
              role-session-name: deploy
        
          - name: Deploy
            uses: cloudposse/github-action-deploy-helmfile@main
            id: deploy
            with:
              aws-region: us-west-2
              cluster: preview-eks
              environment: preview
              namespace: preview
              image: nginx
              image-tag: latest
              operation: deploy
              debug: false
    ```


  Destroy environment
  ```yaml
    name: Pull Request
    on:
      pull_request:
        branches: [ 'main' ]
        types: [closed]

    jobs:
      destroy:
        runs-on: ubuntu-latest
        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::111111111111:role/preview
              role-session-name: destroy          
        
          - name: Destroy
            uses: cloudposse/github-action-deploy-helmfile@main
            id: destroy
            with:
              aws-region: us-west-2
              cluster: preview-eks
              environment: preview
              namespace: preview
              image: "<none>"
              image-tag: "<none>"
              operation: destroy
              debug: false
    ```

include:
  - "docs/github-action.md"

# Contributors to this project
contributors:
  - name: "Igor Rodionov"
    github: "goruha"