diff --git a/actions/release/create/README.md b/actions/release/create/README.md index 759b493..fb75920 100644 --- a/actions/release/create/README.md +++ b/actions/release/create/README.md @@ -24,7 +24,7 @@ ## Overview -Action to create a new release +Create or publish a GitHub release using Release Drafter, with optional monorepo scoping. @@ -39,6 +39,10 @@ Action to create a new release # Default: `false` prerelease: "false" + # Whether to publish the release (false keeps it as a draft) + # Default: `true` + publish: "true" + # Working directory for monorepo support. # If specified, the release configuration file will be placed in `.github/release-configs/{slug}.yml` where slug is derived from the working directory path. # The configuration will include `include-paths` to filter pull requests to only those that modified files in the specified directory. @@ -65,6 +69,7 @@ Action to create a new release | **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 for monorepo support. | **false** | - | | | If specified, the release configuration file will be placed in `.github/release-configs/{slug}.yml` where slug is derived from the working directory path. | | | | | The configuration will include `include-paths` to filter pull requests to only those that modified files in the specified directory. | | | diff --git a/actions/release/create/action.yml b/actions/release/create/action.yml index a99837d..c77c14b 100644 --- a/actions/release/create/action.yml +++ b/actions/release/create/action.yml @@ -1,5 +1,5 @@ name: "Release - Create" -description: "Action to create a new release" +description: "Create or publish a release with Release Drafter, with optional monorepo scoping." author: hoverkraft branding: icon: bookmark @@ -9,6 +9,9 @@ inputs: prerelease: description: "Whether the release is a prerelease" default: "false" + publish: + description: "Whether to publish the release (false keeps it as a draft)" + default: "true" working-directory: description: | Working directory for monorepo support. @@ -56,7 +59,7 @@ runs: env: GITHUB_TOKEN: ${{ inputs.github-token }} with: - publish: true + publish: ${{ inputs.publish }} # config-name is relative to .github/ directory config-name: ${{ steps.get-configuration.outputs.config-name }} prerelease: ${{ inputs.prerelease }}