Skip to content

Changelog API not working for the first tag

Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.

Summary

After creating the first tag in a repository, the changelog API fails

Steps to reproduce

  1. Create a new project (init with a README).
  2. Commit a change with a changelog trailer.
  3. Create a tag
  4. Access the changelog API https://gitlab.com/api/v4/projects/<PROJECT_ID>/repository/changelog?version=<FIRST_TAG>

Example Project

It works as expected if you add the from param https://gitlab.com/api/v4/projects/71233248/repository/changelog?version=v1.0.0&from=0ca5718627d9a1bb981285471fe9949218c62943

I'm not sure what you would do if there was only one commit 🤔

What is the current bug behavior?

The API returns a JSON error message:

{"message":"Failed to generate the changelog: The commit start range is unspecified, and no previous tag could be found to use instead"}

What is the expected correct behavior?

I would expect the API to include all commits where no previous tags exist.

Relevant logs and/or screenshots

Output of checks

Results of GitLab environment info

Expand for output related to GitLab environment info 

(For installations with omnibus-gitlab package run and paste the output of:
`sudo gitlab-rake gitlab:env:info`)

(For installations from source run and paste the output of:
`sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production`)

Results of GitLab application Check

Expand for output related to the GitLab application check 
(For installations with omnibus-gitlab package run and paste the output of:
sudo gitlab-rake gitlab:check SANITIZE=true)


(For installations from source run and paste the output of:
sudo -u git -H bundle exec rake gitlab:check RAILS_ENV=production SANITIZE=true)


(we will only investigate if the tests are passing)

Possible fixes

Patch release information for backports

If the bug fix needs to be backported in a patch release to a version under the maintenance policy, please follow the steps on the patch release runbook for GitLab engineers.

Refer to the internal "Release Information" dashboard for information about the next patch release, including the targeted versions, expected release date, and current status.

High-severity bug remediation

To remediate high-severity issues requiring an internal release for single-tenant SaaS instances, refer to the internal release process for engineers.

Edited by 🤖 GitLab Bot 🤖