cli / cli/cli

The first line of tag message will be appended to the release title when using `--notes-from-tag`

Open
#9,563 0 comments 2 reactions 0 assignees View on GitHub
bug gh-release needs-triage
Dominant language
Go
Stars
46.3k
Forks
9k
Avg merge
2d 6h
Merged PRs (30d)
97

Description

### Describe the bug

When we use `gh release create ${{ github.ref_name }} ...`, the release title will be aligned with the tag name.
If we use this command with the `--notes-from-tag` option, the first line of the tag message will be appended to the title.
But after we declare `--title ${{ github.ref_name }}`, everything works well.

### Steps to reproduce the behavior

[A new tag `v1.1.7` with the message](https://github.com/Goooler/keep-a-changelog/releases/tag/v1.1.7)

```md
### Added

- Arabic translation (#444).
- v1.1 French translation.
- v1.1 Dutch translation (#371).

...
```

then release it on CI with `gh release create ${{ github.ref_name }} --notes-from-tag`, you'll see

image

### Expected vs actual behavior

```
gh release create ${{ github.ref_name }} --notes-from-tag
```
should be aligned with

```
gh release create ${{ github.ref_name }} --title ${{ github.ref_name }} --notes-from-tag
```

in this case, but not for now.

You can see more details at https://github.com/Goooler/keep-a-changelog/pull/1#issuecomment-2328433903.

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the `gh release create ... --notes-from-tag` command described in the issue and compare it with the explicit `--title` form. Trace the release-create entry point and handling of tag notes and title selection; done means the implicit-title behavior matches the explicit tag-name title without appending the first tag-message line.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, github, go
Domain
cli, release
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.