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 (628 stars) (161 forks)batch import
enhancementhelp wanted

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

Tech stack
None
Domain
releasebuild system
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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Knowledge of Gradle plugin developmentUnderstanding of conventional commitsFamiliarity with Git and SCM
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Start by examining the existing VersionIncrementer implementations and the VersionIncrementerContext class to understand the interface. Look at how the plugin currently retrieves commits (likely via Git or SCM provider). The issue suggests adding a method to get commits between current position and previous tag with a depth limit. Check the SCM plugin code (e.g., GitScm) for existing commit retrieval logic.