allegro/axion-release-plugin

Version Incrementer based on Conventional Commits

Open

#497 opened on Jun 16, 2022

View on GitHub
 (4 comments) (2 reactions) (0 assignees)Groovy (161 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (628 stars)
PR merge metrics
 (Avg merge 2d 7h) (8 merged PRs in 30d)

Description

https://www.conventionalcommits.org/en/v1.0.0/#specification

To implement such an incrementer I need commits between the current SCM position and the previous release tag. May you add commits to VersionIncrementerContext (maybe with max depth limit)?

I can contribute such VersionIncrementer but the SCM part (getting commits) is challenging for me.

Contributor guide

Research direction
Study the existing VersionIncrementerContext and how commits are obtained from SCM. Look at the project's SCM abstraction (e.g., Git class) and see how it gets commits between tags. Then add a new field in VersionIncrementerContext to hold the commit list, with a configurable max depth.
Tech stack
None
Domain
releasebuild systemci cd
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitGradle
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40