Add support for pre-release options in release drafter workflow #1308
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1308 +/- ##
=======================================
Coverage 99.87% 99.87%
=======================================
Files 6 6
Lines 827 827
Branches 102 102
=======================================
Hits 826 826
Partials 1 1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
There was a problem hiding this comment.
Pull request overview
This pull request adds workflow dispatch inputs to the release drafter workflow to enable manual creation of pre-releases with configurable identifiers (beta, alpha, or rc). This enhancement allows developers to trigger pre-release creation directly from the GitHub Actions UI.
Changes:
- Added
workflow_dispatchinputs for controlling pre-release creation - Configured the release-drafter action to accept prerelease parameters from workflow inputs
| workflow_dispatch: | ||
| inputs: | ||
| prerelease: | ||
| description: "Create a pre-release (beta)" |
There was a problem hiding this comment.
The description states "Create a pre-release (beta)" but the workflow allows selecting different pre-release identifiers (beta, alpha, or rc). The description should be more generic to reflect all options, such as "Create a pre-release" or "Mark as pre-release".
| description: "Create a pre-release (beta)" | |
| description: "Create a pre-release" |
| uses: release-drafter/release-drafter@v6.1.0 | ||
| with: | ||
| prerelease: ${{ github.event.inputs.prerelease == 'true' }} | ||
| prerelease-identifier: ${{ github.event.inputs.prerelease_identifier }} |
There was a problem hiding this comment.
The prerelease-identifier parameter may not be supported by release-drafter/release-drafter@v6.1.0. The release-drafter action typically only accepts a prerelease boolean parameter. Pre-release identifiers (beta, alpha, rc) are usually controlled through version templates in the release-drafter.yml configuration file rather than as action inputs.
Verify that this parameter is supported in v6.1.0 of the action. If it's not supported, consider either:
- Upgrading to a newer version that supports this parameter (if available)
- Removing this parameter and managing pre-release versioning through the release-drafter.yml configuration file instead
| prerelease-identifier: ${{ github.event.inputs.prerelease_identifier }} |
| - name: 🚀 Run Release Drafter | ||
| uses: release-drafter/release-drafter@v6.1.0 | ||
| with: | ||
| prerelease: ${{ github.event.inputs.prerelease == 'true' }} |
There was a problem hiding this comment.
The expression github.event.inputs.prerelease == 'true' is incorrect for boolean inputs. Since prerelease is defined as type: boolean in the workflow_dispatch inputs, it should be accessed directly without string comparison. The current expression will always return a string result ('true' or 'false') rather than a boolean value.
Change the expression to ${{ github.event.inputs.prerelease }} or if you need to ensure boolean type explicitly, use ${{ github.event.inputs.prerelease == true }} (without quotes).
| prerelease: ${{ github.event.inputs.prerelease == 'true' }} | |
| prerelease: ${{ github.event.inputs.prerelease }} |
This pull request enhances the release workflow configuration by adding support for creating pre-releases (such as beta, alpha, or release candidate versions) directly from the workflow dispatch menu. This makes it easier to manage and automate pre-release versions.
Release workflow improvements:
prereleaseandprerelease_identifierinput options to the workflow dispatch trigger, allowing users to specify whether to create a pre-release and select its type (beta,alpha, orrc).