Skip to content

Commit 4c3184e

Browse files
🩹 [Patch]: Add options to use PR title and body for release naming and notes in Publish-Module workflow
1 parent 3d14498 commit 4c3184e

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

‎.github/workflows/Publish-Module.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,7 @@ jobs:
5858
MinorLabels: ${{ fromJson(inputs.Settings).Publish.Module.MinorLabels }}
5959
PatchLabels: ${{ fromJson(inputs.Settings).Publish.Module.PatchLabels }}
6060
VersionPrefix: ${{ fromJson(inputs.Settings).Publish.Module.VersionPrefix }}
61+
UsePRTitleAsReleaseName: ${{ fromJson(inputs.Settings).Publish.Module.UsePRTitleAsReleaseName }}
62+
UsePRBodyAsReleaseNotes: ${{ fromJson(inputs.Settings).Publish.Module.UsePRBodyAsReleaseNotes }}
63+
UsePRTitleAsNotesHeading: ${{ fromJson(inputs.Settings).Publish.Module.UsePRTitleAsNotesHeading }}
6164
WorkingDirectory: ${{ fromJson(inputs.Settings).WorkingDirectory }}

‎README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -397,6 +397,9 @@ The following settings are available in the settings file:
397397
| `Publish.Module.MinorLabels` | `String` | Labels indicating a minor version bump | `'minor, feature'` |
398398
| `Publish.Module.PatchLabels` | `String` | Labels indicating a patch version bump | `'patch, fix'` |
399399
| `Publish.Module.IgnoreLabels` | `String` | Labels indicating no release | `'NoRelease'` |
400+
| `Publish.Module.UsePRTitleAsReleaseName` | `Boolean` | Use the PR title as the GitHub release name instead of version string | `false` |
401+
| `Publish.Module.UsePRBodyAsReleaseNotes` | `Boolean` | Use the PR body as the release notes content | `true` |
402+
| `Publish.Module.UsePRTitleAsNotesHeading` | `Boolean` | Prepend PR title as H1 heading with PR number link before the body | `true` |
400403
| `Linter.Skip` | `Boolean` | Skip repository linting | `false` |
401404
| `Linter.ShowSummaryOnSuccess` | `Boolean` | Show super-linter summary on success for repository linting | `false` |
402405
| `Linter.env` | `Object` | Environment variables for super-linter configuration | `{}` |
@@ -468,6 +471,9 @@ Publish:
468471
MinorLabels: 'minor, feature'
469472
PatchLabels: 'patch, fix'
470473
IgnoreLabels: 'NoRelease'
474+
UsePRTitleAsReleaseName: false
475+
UsePRBodyAsReleaseNotes: true
476+
UsePRTitleAsNotesHeading: true
471477
472478
Linter:
473479
Skip: false

0 commit comments

Comments
 (0)