Skip to content

feat(release/create): add support for "publish" input #324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Copilot wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(release/create): add support for "publish" input #324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion actions/release/create/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

## Overview

Action to create a new release
Create or publish a GitHub release using Release Drafter, with optional monorepo scoping.

<!-- overview:end -->

Expand All @@ -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.
Expand All @@ -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. | | |
Expand Down
7 changes: 5 additions & 2 deletions actions/release/create/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.
Expand Down Expand Up @@ -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 }}
Expand Down
Loading