orhun/git-cliff

Support limiting the number of tags to process

Open

#844 opened on Sep 9, 2024

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Rust (308 forks)auto 404
feature/requestgood first issue

Repository metrics

Stars
 (12,040 stars)
PR merge metrics
 (PR metrics pending)

Description

Is there an existing issue or pull request for this?

  • I have searched the existing issues and pull requests

Feature description

git-cliff --tag-pattern (?i)prod-.* --tag-n 3

Desired solution

If there are tags like prod-240601, prod-240701, prod-240801, prod-240901, and the latest tag prod-241001, only prod-241001, prod-240901 and prod-240801 should be selected.

Alternatives considered

already there are tag pattern options, it is very easy to add this option.

Additional context

Example shell script
#!/bin/bash

tags=$(git tag -i --sort=taggerdate -l "prod-*" | tail -n 3)
first=$(echo "$tags" | head -n 1)
last=$(echo "$tags" | tail -n 1)
range=$(echo "$first..$last")

git-cliff --tag-pattern "(?i)prod-*" $range -o changelog.md

Contributor guide

Research direction
Implement a new CLI flag ` tag n` to limit the number of tags processed. Parse the flag in the argument parser, then filter the list of tags (after matching the tag pattern) to keep only the most recent N tags. Ensure the filtered tags are used for generating the changelog range.
Tech stack
rust
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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.
Clear
Prerequisites
GitRust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65