Release Notes: Ignore Issue Title if there are release notes written within a given ticket
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
Research direction
Start by finding where the action parses issue bodies for Release Notes and where it formats each issue into the final release draft. Use the examples in the issue as the expected behavior: tickets with release notes should omit the issue title, while tickets without release notes should keep it. The configurable option is mentioned but not specified, so confirm scope before implementing.
Written by the indexing model from the issue text.
Description
Background
Ignore Issue title if a given Issue has Release Notes in it. I find this to potentially improve the readability of our Releases - let's keep the information brief but detailed enough and tidy.
Or even better, make it configurable.
Example
Imagine that you have tickets 111 and 112, as detailed below.
Ticket 111 (author A1 worked on it)
Title: Implement Algorithm BFS for problem X
Release Notes
- BFS implemented for problem X
- Optimized the backend part Y by Z amount of % on average
Ticket 112 (author A2 worked on it)
Title: Enhancing Monitoring of the service Q
(and this ticket would have no release notes)
Final Release Draft would look like this:
...
New Features 🎉
-
#111 by @ A1
- BFS implemented for problem X
- Optimized the backend part Y by Z amount of % on average
-
#112 Enhancing Monitoring of the service Q by @ A2
...
- Dominant language
- Python
- Stars
- 13
- Forks
- 0
- Avg merge
- 1m
- Merged PRs (30d)
- 5
Getting set up
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from AbsaOSS/generate-release-notes
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 3/5 1-2 days Newbie friendliness 70/100
-
Difficulty 4/5 3-5 days Newbie friendliness 50/100
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
-
epic
Difficulty 5/5 Over a week Newbie friendliness 30/100
All issues in AbsaOSS/generate-release-notes
Similar issues
-
bug status/needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
prowler-cloud/prowler#12887 · 1 comment ·
Maintainers usually reply within 1 day
-
area: desktop platform: macos priority: p3 status: ready type: enhancement
Difficulty 1/5 Under an hour Newbie friendliness 92/100
use-agent-os/agent-os#3484 ·
Maintainers usually reply within 2 days
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
open-telemetry/opentelemetry-python-contrib#5113 · 2 comments · 2 reactions ·
Maintainers usually reply within 1 day
-
external
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
langchain-ai/docs#6255 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day