Skip to content

Commit 709a6c8

Browse files
authored
Improve the release issue template & release notes regexes docs (#2526)
1 parent d0c5d95 commit 709a6c8

File tree

3 files changed

+19
-3
lines changed

3 files changed

+19
-3
lines changed

.github/ISSUE_TEMPLATE/new_release.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,10 @@ v[VERSION]
1414
[RELEASE DATE]
1515

1616
**Release procedure**
17-
Please refer to
18-
the [Release Procedure doc](https://github.com/VirtusLab/scala-cli/blob/main/.github/release/release-procedure.md).
17+
Please refer to the [Release Procedure doc](https://github.com/VirtusLab/scala-cli/blob/main/.github/release/release-procedure.md).
1918

2019
**Release notes**
2120
Please remember to create a pull request with a draft of the release notes in the [Release Notes History doc](https://github.com/VirtusLab/scala-cli/blob/main/website/docs/release_notes.md).
22-
Please make sure the notes render correctly on [the website](https://scala-cli.virtuslab.org/docs/release_notes) - that includes swapping out GitHub-idiomatic @mentions of users, links to PRs, issues, etc.
21+
Please make sure the notes render correctly on [the website](https://scala-cli.virtuslab.org/docs/release_notes).
22+
That includes swapping out GitHub-idiomatic @mentions of users, links to PRs, issues, etc.
23+
You can do that using the [regexes provided in this doc](https://github.com/VirtusLab/scala-cli/blob/main/.github/release/release-notes-regexes.md)
Loading

.github/release/release-notes-regexes.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
# Regexes for preparing Scala CLI release notes
2+
3+
When auto-generating release notes from the GitHub UI, the notes will contain GitHub-idiomatic @mentions of users,
4+
links to PRs, issues, etc. Those have to then be swapped out for the corresponding Markdown syntax to be rendered
5+
correctly on our documentation website.
6+
What's worse, the GitHub syntax has to be preserved in the GitHub release description, as using the full Markdown
7+
syntax required by our website breaks the GitHub mouse hover magic.
8+
9+
To make the process of switching the syntax faster, you can use the following regexes.
10+
11+
Do keep in mind that IDEA IntelliJ allows to automatically apply regexes when replacing text, so you can use that to
12+
fix the release notes on the fly.
13+
14+
![image](img/apply-regexes-on-release-notes-in-intellij.png)
15+
116
## PR link
217
Find: `in https\:\/\/github\.com\/VirtusLab\/scala\-cli\/pull\/(.*?)$` </br>
318
Replace: `in [#$1](https://github.com/VirtusLab/scala-cli/pull/$1)`

0 commit comments

Comments
 (0)