Package gbp :: Package scripts :: Module dch
[hide private]
[frames] | no frames]

Module dch

Generate Debian changelog entries from git commit messages

Functions [hide private]
 
system(cmd)
 
spawn_dch(msg=[], author=None, email=None, newversion=False, version=None, release=False, distribution=None, dch_options='')
Spawn dch
 
add_changelog_entry(msg, author, email, dch_options)
Add a single changelog entry
 
guess_version_from_upstream(repo, upstream_tag_format, cp)
Guess the version based on the latest version on the upstream branch
 
add_changelog_section(msg, distribution, repo, options, cp, author=None, email=None, version={}, dch_options='')
Add a new section to the changelog
 
get_author_email(repo, use_git_config)
Get author and email from git configuration
 
fixup_trailer(repo, git_author, dch_options)
Fixup the changelog trailer's comitter and email address.
 
snapshot_version(version)
Get the current release and snapshot version.
 
mangle_changelog(changelog, cp, snapshot='')
Mangle changelog to either add or remove snapshot markers
 
do_release(changelog, repo, cp, git_author, dch_options)
Remove the snapshot header and set the distribution
 
do_snapshot(changelog, repo, next_snapshot)
Add new snapshot banner to most recent changelog section.
 
parse_commit(repo, commitid, opts, last_commit=False)
Parse a commit and return message, author, and author email
 
guess_snapshot_commit(cp, repo, options)
Guess the last commit documented in the changelog from the snapshot banner or the last point the changelog was touched.
 
get_customizations(customization_file)
 
process_options(options, parser)
 
process_editor_option(options)
Determine text editor and check if we need it
 
changelog_commit_msg(options, version)
 
main(argv)
Variables [hide private]
  user_customizations = {}
  snapshot_re = re.compile(r'\s*\*\* SNAPSHOT build @(?P<commit>...
  __package__ = 'gbp.scripts'
Function Details [hide private]

spawn_dch(msg=[], author=None, email=None, newversion=False, version=None, release=False, distribution=None, dch_options='')

 

Spawn dch

Parameters:
  • author - committers name
  • email - committers email
  • newversion - start a new version
  • version - the verion to use
  • release - finalize changelog for releaze
  • distribution - distribution to use
  • dch_options - options passed verbatim to dch

fixup_trailer(repo, git_author, dch_options)

 

Fixup the changelog trailer's comitter and email address.

It might otherwise point to the last git committer instead of the person creating the changelog

snapshot_version(version)

 

Get the current release and snapshot version.

Format is <debian-version>~<release>.gbp<short-commit-id>

>>> snapshot_version('1.0-1')
('1.0-1', 0)
>>> snapshot_version('1.0-1~1.test0')
('1.0-1~1.test0', 0)
>>> snapshot_version('1.0-1~2.gbp1234')
('1.0-1', 2)

mangle_changelog(changelog, cp, snapshot='')

 

Mangle changelog to either add or remove snapshot markers

Parameters:
  • snapshot (str) - SHA1 if snapshot header should be added/maintained, empty if it should be removed

do_snapshot(changelog, repo, next_snapshot)

 

Add new snapshot banner to most recent changelog section. The next snapshot number is calculated by eval()'ing next_snapshot.


Variables Details [hide private]

snapshot_re

Value:
re.compile(r'\s*\*\* SNAPSHOT build @(?P<commit>[a-z0-9]+)\s+\*\*')