README.md

GitHub Action: Release - Create

---

Overview

Create or publish a release with Release Drafter, with optional monorepo scoping.

Usage

- uses: hoverkraft-tech/ci-github-publish/actions/release/create@b56be562f38e0e3e712f09691a8fe930aae9db1b # 0.22.0
  with:
    # Whether the release is a prerelease
    # Default: `false`
    prerelease: "false"

    # Whether to publish the release (false keeps it as a draft)
    # Default: `true`
    publish: "true"

    # 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 creating the release.
    # Permissions:
    # - contents: write
    # - pull-requests: read
    #
    # Default: `${{ github.token }}`
    github-token: ${{ github.token }}

Inputs

Input	Description	Required	Default
prerelease	Whether the release is a prerelease	false	false
publish	Whether to publish the release (false keeps it as a draft)	false	true
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 creating the release.	false	${{ github.token }}
	Permissions:
	- contents: write
	- pull-requests: read

Outputs

Output	Description
tag	The tag of the release

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.