Skip to content

Commit

Permalink
- Moved mention of case-sensivity for Release Notes: detection string.
Browse files Browse the repository at this point in the history
  • Loading branch information
miroslavpojer committed Oct 16, 2024
1 parent 3f02bfd commit 9e11d4d
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,10 +166,10 @@ Add the following step to your GitHub workflow (in example are used non-default
#### Release Notes Extraction Process
This feature searches for release notes in the description of GitHub pull requests, making it easier for maintainers to track changes and updates.
- **Format:**
- The release notes section have to begin with the title `Release Notes:`, followed by the release notes in bullet points. [See Markdown formatting is supported](https://www.markdownguide.org/basic-syntax/#unordered-lists).
- The release notes section have to begin with the title `Release Notes:` (case-sensitive), followed by the release notes in bullet points. [See Markdown formatting is supported](https://www.markdownguide.org/basic-syntax/#unordered-lists).
- If no release notes line is detected under the `Release Notes:` title, no release notes will be printed in the output.
- **Example:**
- Here are examples of how to structure the release notes (case-sensitive):
- Here are examples of how to structure the release notes:
```
Release Notes:
- This update introduces a new caching mechanism that improves performance by 20%.
Expand Down

0 comments on commit 9e11d4d

Please sign in to comment.