AbsaOSS / AbsaOSS/generate-release-notes

Adding optional parameter - create annotated git tag

Open
#332 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
13
Forks
0
Avg merge
6h 50m
Merged PRs (30d)
7

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 `false` then it should not create tag and it should fail loudly.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.