Adding optional parameter - create annotated git tag
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 70/100
Research direction
Start by locating the action input schema and the generator entrypoint where git tags are currently handled, then wire in a new optional tag-creation input. Trace the existing flow for missing/creating tags and adjust behavior so true creates when absent (warn if already present) and false explicitly skips creation with a loud failure. Run the project’s normal tests or CI check for release-note generation, and verify docs/examples describe the new option and its expected outcomes.
Written by the indexing model from the issue text.
Description
Feature Description
Currently, with the newest version of v1.3.2, the Release Notes Generator does assume that the Git Tag already exists. If it does not exist, the action fails.
The way we solved this is that we explicitly create the Git Tag one step before the Release Notes Generator - but this is logically so close to the RN generator workflow, that it could be part of it - configurable by user.
Problem / Opportunity
Every CI action involving RN Generator must have a git tag creation there. Since this is used on almost every repository, our CI files could be slightly simpler - reducing git tag creation code.
Acceptance Criteria
The RN generator contains 1 optional parameter, maybe boolean tag-creation or something like that.
- If it's
true, then it will be created (and if it exists already maybe it should just emit warning). - If
falsethen it should not create tag and it should fail loudly.
- Dominant language
- Python
- Stars
- 13
- Forks
- 0
- Avg merge
- 6h 50m
- Merged PRs (30d)
- 7
Contributor 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
-
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
-
epic
Difficulty 5/5 Over a week Newbie friendliness 25/100
All issues in AbsaOSS/generate-release-notes
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100