apricote/releaser-pleaser
1
0
Fork 0
mirror of https://github.com/apricote/releaser-pleaser.git synced 2026-01-13 13:21:00 +00:00
Code Issues Projects Releases Packages Wiki Activity

fix: using code blocks within release-notes (#275)

Browse source 
Increase the number of code blocks backticks to 4 for the release note prefix and suffix, to allow users to embed their own code blocks using only 3 backticks.
This commit is contained in:
Jonas L. 2025-09-25 12:25:35 +02:00 • committed by GitHub
parent 93bb42e781
commit 612928a382
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
13 changed files with 229 additions and 103 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/guides/release-notes.md
View file

@ -43,17 +43,17 @@ The release pull request description has text fields where maintainers can add t
When you edit the description, make sure to put your desired content into the code blocks named `rp-prefix` and `rp-suffix`. Only the content of these blocks is considered.
> ```rp-prefix
> ~~~~rp-prefix
> ### Prefix
>
> This will be shown as the Prefix.
> ```
> ~~~~
>
> ```rp-suffix
> ~~~~rp-suffix
> ### Suffix
>
> This will be shown as the Suffix.
> ```
> ~~~~
To match the style of the auto-generated release notes, you should start any headings at level 3 (`### Title`).

8
docs/reference/pr-options.md
View file

@ -30,17 +30,17 @@ Any text in code blocks with these languages is being added to the start or end
**Examples**:
```rp-prefix
~~~~rp-prefix
#### Awesome new feature!
This text is at the start of the release notes.
```
~~~~
```rp-suffix
~~~~rp-suffix
#### Version Compatibility
And this at the end.
```
~~~~
### Status