Specify GitLab branch

[seanmil]

Is there an existing issue or pull request for this?

• I have searched the existing issues and pull requests

Feature description

The API calls used for GitLab currently do not specify the branch - which means the default branch is always used. There should be a way (configuration setting and/or environment variable) which specifies which branch / reference should be used when looking for commits. This would allow GitLab metadata to be retrieved correctly if a changelog was being generated for a branch other than the GitLab default branch.

Desired solution

Provide a configuration option such as:

[remote.gitlab]
branch = "other_branch"

or an environment variable such as: GITLAB_BRANCH which, when specified, sets the ref_name parameter of the GitLab Commits API call which will return the commits specific to that branch instead of the default branch.

Alternatives considered

I don't believe there are any other viable alternatives, other than limiting GitLab-integrated changelog generation to only the default branch.

Additional context

Unlike the commits API call, the Merge Request list API call returns all project MRs regardless of branch. Thanks!

[welcome]

Thanks for opening your first issue at git-cliff! Be sure to follow the issue template! ⛰️

[orhun]

Thanks for reporting! I agree that we should be able to specify the branch for the request. I'll look into this after the release.