&rpm-email;
&rpm-firstname;
&rpm-surname;
gbp-rpm-ch
&rpm-mansection;
gbp-rpm-ch;Generate the RPM changelog from git commit messages
&gbp-rpm-ch;
&man.common.options.synopsis;
=DIRECTORY=VENDORBRANCH-NAMETAG-FORMATDIRECTORYFILEPATHFILEPATHCOMMITISHNUMBERREGEXREV-FORMATGIT-LOG-OPTIONSEDITORCUSTOMIZATION-FILE[PATH1 PATH2]DESCRIPTION
&gbp-rpm-ch; reads git commit messages up to the current tip of the current
branch and updates the RPM changelog from them.
By default, &gbp-rpm-ch; tries to guess the last &git; commit documented in
the changelog. Alternatively, can be used to
tell &gbp-rpm-ch; at which point it should start in the &git; history, or,
to use all commits from the &git; history.
The additional path arguments can be used to restrict the repository paths
&gbp-rpm-ch; looks at. For even more detailed control, you can use
to restrict the generated changelog entries
further. E.g. by using
"--author=Foo Bar".
OPTIONS
&man.common.options.description;
=DIRECTORY
Base directory under which temporary directories are created.
=VENDOR
Distribution vendor name.
=BRANCH-NAME
The branch in the Git repository the package is being developed on,
default is master.
Don't check if the current branch matches
PACKAGING-BRANCH.
TAG-FORMAT
Tag format used, when tagging releases,
default is %(vendor)s/%(version)sDIRECTORY
Subdirectory that contains the RPM packaging files.
FILEPATH
Relative path to the changelog file to use. Special value
auto causes &gbp; to guess,
SPEC uses the spec file,
CHANGES uses a separate changelog file
(name derived spec file name with .spec suffix replaced by .changes).
Guessing logic is simple: use separate changelog file if it is found,
otherwise use the spec file.
FILEPATH
Relative path to the spec file to use. Special value
auto causes &gbp; to search and guess.
Other values cause the option to be
ignored: the directory of the spec file is used, instead.
COMMITTISH
Start reading commit messages at
COMMITTISH.
Do not create a new changelog section, just update the last
changelog section.
Include the full commit message in the changelog output.
GIT-LOG-OPTIONS
Options passed on verbatim to git-log(1).
N
Include N digits of the commit id in the
changelog entry. Default is to not include any commit ids at all.
REGEX
Ignore lines in commit message matching
REGEX when generating the changelog.
REV-FORMAT
Format string to use for revision field in the changelog header. The
following string fields are accepted:
%(upstreamversion)s the upstream version;
%(release)s the rpm patchlevel, i.e.
Release; %(version)s full rpm package
version; %(tagname)s tag/commit, i.e.
basically what git-describe would give.
If empty or not defined the default from packaging policy is used.
REGEX
Ignore commit lines matching REGEX
when generating the changelog.
Use user.name and user.email from
git-config(1) for the changelog header.
Whether to spawn an editor: always, when doing a release or never.
The editor to use for editing the changelog.
CUSTOMIZATION-FILE
Load Python code from CUSTOMIZATION-FILE.
At the moment, the only useful thing the code can do is define a
custom ChangelogEntryFormatter class.
META TAGS
Additional to the above options the formatting of the new changelog entries
(one-per-commit) in the changelog can be modified by special tags (called
Meta Tags) given in the git commit message. The tags must start at the
first column of a commit message but can appear on any line. They are of
the form : VALUE. Valid
Meta Tags are:
: ACTION
Supported actions are: Ignore which will
ignore this commit when generating new changelog entries.
Short which will only use the description
(the first line) of the commit message when generating the changelog
entry (useful when is given) and
Full which will use the full commit
message when generating the changelog entry (useful when
is not given).
: BUGNUMBER
Indicate in the changelog entry that bug
BUGNUMBER was addressed in this commit.
The following git commit message:
Document meta tags
so one doesn't have to consult the manual
Git-Rpm-Ch: Short
Closes: #636088
Results in this changelog entry:
- Document meta tags (Closes: #636088)
&man.gbp.config-files;
SEE ALSO,
,
,
&man.seealso.common;
Cl2vcs,
AUTHOR
&rpm-username; &rpm-email;