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-argocd

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

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

introduction: |-
  Deploy on Kubernetes with Helm/HelmFile and ArgoCD. 

references:
  - name: "github-actions-workflows"
    description: "Reusable workflows for different types of projects"
    url: "https://github.com/cloudposse/github-actions-workflows"


# 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-argocd@main
            id: deploy
            with:
              cluster: https://github.com/cloudposse/argocd-deploy-non-prod-test/blob/main/plat/ue2-sandbox/apps
              toolchain: helmfile
              environment: preview
              namespace: preview
              application: test-app
              github-pat: ${{ secrets.GITHUB_AUTH_PAT }}
              repository: ${{ github.repository }}
              ref: ${{ github.event.pull_request.head.ref  }}
              image: nginx
              image-tag: latest
              operation: deploy
              debug: false
              synchronously: true
              deployment-id: ${{ github.run_id }}-${{ github.run_attempt }}
    ```


  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:
              cluster: https://github.com/cloudposse/argocd-deploy-non-prod-test/blob/main/plat/ue2-sandbox/apps
              toolchain: helmfile
              environment: preview
              namespace: preview
              application: test-app
              github-pat: ${{ secrets.GITHUB_AUTH_PAT }}
              repository: ${{ github.repository }}
              ref: ${{ github.event.pull_request.head.ref }}  
              image: "<none>"
              image-tag: "<none>"
              operation: destroy
              debug: false
    ```


  ### Deduping ArgoCD notifications per deploy attempt

  ArgoCD's notification `oncePer` trigger dedupes on whichever field you point it at. Keying it on the
  application commit means a rollback — replaying a commit ArgoCD has already notified for — is silently
  suppressed, and the rollback reports no status at all.

  Pass `deployment-id` a value that is unique per *deploy attempt* rather than per code state, and point
  `oncePer` at it instead:

  ```yaml
    - name: Deploy
      uses: cloudposse/github-action-deploy-argocd@main
      with:
        # ...
        deployment-id: ${{ github.run_id }}-${{ github.run_attempt }}
  ```

  The value is written to the generated `config.yaml` alongside the rest of the deploy metadata:

  ```yaml
    app_repository: acme/example-app
    app_commit: 6e6a0e1b0e0c4b2a9f1d3c5e7a9b1d3f5a7c9e1b
    app_hostname: https://example-app.example.com
    name: preview.example-app
    namespace: preview
    manifests: plat/ue2-sandbox/apps/preview/example-app/manifests
    deployment_id: "12345678901-2"
  ```

  The input is optional. Left at its empty default, the `deployment_id` key is omitted from `config.yaml`
  entirely, so callers that do not set it get byte-identical output.

include: []
contributors: []