Commit ce4aac7
authored
🚀 [Feature]: Add PR-based release notes settings (#5)
The settings action now supports three new configuration options that
control how GitHub release notes are generated from pull requests.
- Relates to PSModule/Process-PSModule#263
## New settings schema
The following settings are now available in the `Publish.Module` section
of your `.github/PSModule.yml`:
| Setting | Type | Default | Description |
|---------|------|---------|-------------|
| `UsePRTitleAsReleaseName` | `boolean` | `false` | Use pull request
title as the GitHub release name |
| `UsePRBodyAsReleaseNotes` | `boolean` | `true` | Use pull request body
as the release notes content |
| `UsePRTitleAsNotesHeading` | `boolean` | `true` | Add pull request
title as H1 heading in release notes |
## Schema changes
The JSON schema in
[scripts/Settings.schema.json](scripts/Settings.schema.json) has been
updated to include the new properties with proper type definitions and
descriptions.
## Default values
The [scripts/main.ps1](scripts/main.ps1) file now outputs these settings
with sensible defaults:
- `UsePRTitleAsReleaseName`: `false` (release name uses version tag)
- `UsePRBodyAsReleaseNotes`: `true` (PR body becomes release notes)
- `UsePRTitleAsNotesHeading`: `true` (PR title appears as heading with
PR link)1 parent 5be8144 commit ce4aac7
2 files changed
+25
-10
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
161 | 161 | | |
162 | 162 | | |
163 | 163 | | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
164 | 176 | | |
165 | 177 | | |
166 | 178 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
162 | 162 | | |
163 | 163 | | |
164 | 164 | | |
165 | | - | |
166 | | - | |
167 | | - | |
168 | | - | |
169 | | - | |
170 | | - | |
171 | | - | |
172 | | - | |
173 | | - | |
174 | | - | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
175 | 178 | | |
176 | 179 | | |
177 | 180 | | |
| |||
0 commit comments