NAME¶

glab-changelog-generate - Generate a changelog for the current project.

SYNOPSIS¶

glab changelog generate [flags]

DESCRIPTION¶

Generates a changelog from the commits in your project's Git repository. If you do not pass --version, glab determines the version by running git describe against your local tags.

By default, GitLab reads the changelog configuration from .gitlab/changelog_config.yml in the project. To use a different file, pass --config-file.

To limit the range of commits, use --from and --to. glab excludes the --from commit from the range and includes the --to commit. The --to commit defaults to HEAD of the project's default branch.

OPTIONS¶

--config-file="" Path to the changelog configuration file in the project's Git repository. Defaults to '.gitlab/changelog_config.yml'.

--date="" Date and time of the release, in ISO 8601 format (2016-03-11T03:45:40Z). Defaults to the current time.

--from="" Start of the range of commits to use when generating the changelog, as a SHA. This commit is not included in the range.

--to="" End of the range of commits to use when generating the changelog, as a SHA. This commit is included in the range. Defaults to the HEAD of the project's default branch.

--trailer="" The Git trailer to use to include commits. Defaults to 'Changelog'.

-v, --version="" Version to generate the changelog for. Must follow semantic versioning. Defaults to the version detected by 'git describe'.

OPTIONS INHERITED FROM PARENT COMMANDS¶

-h, --help[=false] Show help for this command.

EXAMPLE¶

# Generate a changelog for the version detected by 'git describe'
glab changelog generate
# Generate a changelog for a specific version
glab changelog generate --version 1.2.0
# Generate a changelog for commits between two SHAs
glab changelog generate --from abc123 --to def456

SEE ALSO¶

glab-changelog(1)