README.md

GitHub Action: Release - Plan

---

Overview

Plan a release identity without creating a Git tag or GitHub release.

Usage

- uses: hoverkraft-tech/ci-github-publish/actions/release/plan@ed354ada70b9f518c2bb663e18a80041c2cf5156 # 0.27.1
  with:
    # Whether to plan the release as a prerelease
    # Default: `false`
    prerelease: "false"

    # Working directory used to scope release automation in a monorepo.
    # If specified, the action looks for `.github/release-configs/{slug}.yml`, where `slug` is derived from the working directory basename.
    # If that file does not exist, a temporary release configuration is generated with `include-paths` for the working directory and current workflow file.
    working-directory: ""

    # Additional paths to include in the release notes filtering (JSON array).
    # These paths are added to the `include-paths` configuration of release-drafter.
    #
    # Default: `[]`
    include-paths: "[]"

    # GitHub Token for planning the release.
    # Permissions:
    # - contents: read
    # - pull-requests: read
    #
    # Default: `${{ github.token }}`
    github-token: ${{ github.token }}

Inputs

Input	Description	Required	Default
prerelease	Whether to plan the release as a prerelease	false	false
working-directory	Working directory used to scope release automation in a monorepo.	false	-
	If specified, the action looks for .github/release-configs/{slug}.yml, where slug is derived from the working directory basename.
	If that file does not exist, a temporary release configuration is generated with include-paths for the working directory and current workflow file.
include-paths	Additional paths to include in the release notes filtering (JSON array).	false	[]
	These paths are added to the include-paths configuration of release-drafter.
github-token	GitHub Token for planning the release.	false	${{ github.token }}
	Permissions:
	- contents: read
	- pull-requests: read

Outputs

Output	Description
tag	The planned release tag
name	The planned release name

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.