README.md

GitHub Action: Clean deploy - Via a repository dispatch

---

Overview

Action to clean a deployment 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/clean-deploy/repository-dispatch@b56be562f38e0e3e712f09691a8fe930aae9db1b # 0.22.0
  with:
    # 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 }}

    # Target repository where the deployment should be cleaned.
    # This input is required.
    repository: ""

    # Environment where to clean the deployment.
    # This input is required.
    environment: ""

Inputs

Input	Description	Required	Default
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.
repository	Target repository where the deployment should be cleaned.	true	-
environment	Environment where to clean the deployment.	true	-

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.