README.md

GitHub Action: Deploy Helm chart via a repository dispatch

---

Overview

Action to deploy an Helm chart via GitHub repository dispatch event. See https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#create-a-repository-dispatch-event. See https://github.com/peter-evans/repository-dispatch.

The target repository should implement a workflow that handle this dispatch event. See https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#repository_dispatch.

Usage

- uses: hoverkraft-tech/ci-github-publish/actions/deploy/helm-repository-dispatch@84d583ba7b357f9476707f54cf5419d630ae0145 # 0.26.2
  with:
    # Deployment ID to be used in the ArgoCD application manifest
    # This input is required.
    deployment-id: ""

    # Chart to deploy. Example: `ghcr.io/my-org/my-repo/charts/application/my-repo:0.1.0-rc.0`.
    #
    # This input is required.
    chart: ""

    # Chart values to be sent to deployment. JSON array. Example:
    # ```json
    # [
    # { "path": ".application.test", "value": "ok" }
    # ]
    # ```
    chart-values: ""

    # Target repository where to deploy given chart.
    # This input is required.
    repository: ""

    # Environment where to deploy given chart.
    # This input is required.
    environment: ""

    # The URL which respond to deployed application.
    # This input is required.
    url: ""

    # GitHub Token for dispatch an event to a remote repository.
    # Permissions:
    # - contents: write
    # See https://github.com/peter-evans/repository-dispatch#usage.
    #
    # Default: `${{ github.token }}`
    github-token: ${{ github.token }}

    # Username to record as having initiated the sync operation
    # This input is required.
    initiated-by: ""

Inputs

Input	Description	Required	Default
deployment-id	Deployment ID to be used in the ArgoCD application manifest	true	-
chart	Chart to deploy. Example: ghcr.io/my-org/my-repo/charts/application/my-repo:0.1.0-rc.0.	true	-
chart-values	Chart values to be sent to deployment. JSON array. Example:	false	-
	[ { "path": ".application.test", "value": "ok" } ]
repository	Target repository where to deploy given chart.	true	-
environment	Environment where to deploy given chart.	true	-
url	The URL which respond to deployed application.	true	-
github-token	GitHub Token for dispatch an event to a remote repository.	false	${{ github.token }}
	Permissions:
	- contents: write
	See https://github.com/peter-evans/repository-dispatch#usage.
initiated-by	Username to record as having initiated the sync operation	true	-

Outputs

Output	Description
url	URL of the deployed application

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

For more details, see the license.

---

This documentation was automatically generated by CI Dokumentor.