finish-deploy-argocd-app-of-apps.md

GitHub Reusable Workflow: Finish deploy - ArgoCD App of Apps

---

Overview

Reusable workflow to finish a deploy process in an ArgoCD App Of Apps Pattern context. See https://argo-cd.readthedocs.io/en/stable/operator-manual/cluster-bootstrapping/#app-of-apps-pattern.

This workflow is triggered by a repository dispatch event. See https://docs.github.com/en/actions/reference/events-that-trigger-workflows#repository_dispatch. Payload:

{
  "event_type": "finish-deploy",
  "client_payload": {
    "deployment-id": "unique deployment id (e.g. 1234)",
    "application-repository": "repository name (e.g. my-repository)",
    "urls": "URL(s) of the deployed application. (e.g. ['https://my-application.com'])",
    "status": "status of the deployment (e.g. "Synced", "failure")",
    "description": "description of the deployment (e.g. "deployment successful")",
  }
}

Permissions

• actions: read
• contents: read
• deployments: write
• id-token: write
• issues: write
• pull-requests: write

Usage

name: Finish deploy - ArgoCD App of Apps
on:
  push:
    branches:
      - main
permissions: {}
jobs:
  finish-deploy-argocd-app-of-apps:
    uses: hoverkraft-tech/ci-github-publish/.github/workflows/finish-deploy-argocd-app-of-apps.yml@b56be562f38e0e3e712f09691a8fe930aae9db1b # 0.22.0
    permissions: {}
    secrets:
      # GitHub Token to update the deployment.
      # Permissions:
      # - deployments: write
      # See <https://docs.github.com/en/rest/deployments/statuses?apiVersion=2022-11-28#create-a-deployment-status>.
      github-token: ""

      # GitHub App private key to generate GitHub token in place of github-token.
      # See <https://github.com/actions/create-github-app-token>.
      github-app-key: ""
    with:
      # JSON array of runner(s) to use.
      # See <https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job>.
      #
      # Default: `["ubuntu-latest"]`
      runs-on: '["ubuntu-latest"]'

      # GitHub App ID to generate GitHub token in place of github-token.
      # See <https://github.com/actions/create-github-app-token>.
      github-app-id: ""

Inputs

Workflow Call Inputs

Input	Description	Required	Type	Default
runs-on	JSON array of runner(s) to use.	false	string	["ubuntu-latest"]
	See https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job.
github-app-id	GitHub App ID to generate GitHub token in place of github-token.	false	string	-
	See https://github.com/actions/create-github-app-token.

Secrets

Secret	Description	Required
github-token	GitHub Token to update the deployment.	false
	Permissions:
	- deployments: write
	See https://docs.github.com/en/rest/deployments/statuses?apiVersion=2022-11-28#create-a-deployment-status.
github-app-key	GitHub App private key to generate GitHub token in place of github-token.	false
	See https://github.com/actions/create-github-app-token.

Contributing

Contributions are welcome! Please see the contributing guidelines for more details.

License

This project is licensed under the MIT License.

SPDX-License-Identifier: MIT

Copyright © 2026 hoverkraft-tech

For more details, see the license.

---

This documentation was automatically generated by CI Dokumentor.