In newly created draft hashes are not linked.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
Research direction
The issue describes missing links in newly created release drafts and suggests generating fully specified Markdown links, but it does not name files or tests. Start by reading the release draft generation entry point and its existing tests. Done means issue and pull request references are linked when the draft is first created; the linked open pull request #362 shows this work is already under way.
Written by the indexing model from the issue text.
Description
Describe the bug
When a draft is newly created the mentioned issues and PRs prefixed by hash are not considered as links.
So it's show like #3 instead of #358
Steps to Reproduce
- Create a draft of a release with at least one issue or PR
- Check the newly created release draft
- (note) The moment the Draft is edited and saved, the links are filled in
Expected state
The links are present from get go.
The suggested solution is to create fully specified markdown link in the draft.
Eg. [#358](https://github.com/AbsaOSS/generate-release-notes/issues/358) -> #358
(After all, GitHub's own release note generator does that.)
Impact / Severity
Medium
Attachments / Evidence
Desktop
No response
Related / References
No response
- Dominant language
- Python
- Stars
- 12
- Forks
- 0
- Avg merge
- 1m
- Merged PRs (30d)
- 6
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
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
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 58/100
-
Release v1.4.0Possibly taken @miroslavpojer claimed this 1 day ago. Openepic
AbsaOSS/generate-release-notes#358 · 1 assignee ·
-
Fix broken workflow examples and stale action version commentsPossibly taken @miroslavpojer claimed this 1 day ago. Openbug documentation tech debt
AbsaOSS/generate-release-notes#356 · 1 assignee ·
All issues in AbsaOSS/generate-release-notes
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
abetlen/llama-cpp-python#2424 ·
Maintainers usually reply within 1 day
-
Bug IronPython Python 3
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
pyrevitlabs/pyRevit#4184 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 74/100
jqueryscript/awesome-claude-code#1009 ·
-
tests
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day