github-changelog-generator / github-changelog-generator/github-changelog-generator

Can we get tag annotations

Open
#730 6 comments 0 reactions 0 assignees View on GitHub
feature-request
Dominant language
Ruby
Stars
7.5k
Forks
843
PR merge metrics
No merged PRs in 30d

Description

Is it possible to fetch the tag title and annotations for each tag, subsequently add them to each tag's description?

```markdown
## [v1.7.5f](https://github.com) (2019-06-21)
[Full Changelog](https://github.com)

**Description:**
*Tag's title goes here*

- *Tag's annotations goes here*

**Merged pull requests:**
...
```

https://github.com/github-changelog-generator/github-changelog-generator/blob/f73e689ef1d4b8726aa39c4dc5cc8671da0d45e2/lib/github_changelog_generator/octo_fetcher.rb#L109

I'm not familiar with Ruby otherwise I would raise a PR for this.

Contributor guide

Open the contributing guide

Research direction

Start in lib/github_changelog_generator/octo_fetcher.rb around line 109 and trace how tags are fetched and passed into changelog rendering. Check the existing generated Markdown structure, then verify that each tag's title and annotations appear in its description without disrupting the other sections.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, ruby
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.