| GENERATE_RECIPES_CHANGELOG(1) | Keg - Image Composition Tool | GENERATE_RECIPES_CHANGELOG(1) |
NAME¶
generate_recipes_changelog - change log generator for keg images
SYNOPSIS¶
generate_recipes_changelog [options] <logfile>
DESCRIPTION¶
generate_recipes_changelog generates a change log from the git commit history of one or more keg-recipes repositories. The input file is a source info log that is generated by keg when run with source tracking enabled (-s command line switch).
The exit status is 0 in case a change log was generated successfully, 1 in case an error occurred, or 2 in case no error occurred but generated change log is empty.
ARGUMENTS¶
logfile
OPTIONS¶
- -o OUTPUT_FILE
- Write output to OUTPUT_FILE (stdout if omitted)
-r PATH:REV
NOTE:
- -f FORMAT
- Output format, 'text' or 'yaml' [default: yaml]
- -m MSG_FORMAT
- Format spec for commit messages (see 'format:<string>' in 'man git-log') [default: - %s] (only used with text format)
- -t ROOT_TAG
- Use ROOT_TAG for yaml output (e.g. image version)
EXAMPLE¶
generate_recipes_changelog -r /path/to/repo:12345678.. -t 1.1.8 log_sources
This will produce a YAML change log, namespaced with 1.1.8, intended as a version number, only considering commits after hash 12345678. If 12345678 was the hash of the HEAD commit in the checked out branch at /path/to/repo at the previous run of generate_recipes_changelog on the same data set, this would limit the change log to only contain newer changes. This method can be used to produce incremental change logs.
The change log will have the following format:
1.1.8:
- change: git message subject
date: git commit UTC timestamp
details: |-
git message body
...
AUTHOR¶
public-cloud-dev@susecloud.net
COPYRIGHT¶
2023, SUSE - Public Cloud Team
| July 28, 2023 | 2.1.1 |