Package hudson.plugins.git

Class GitChangeLogParser

java.lang.Object

hudson.scm.ChangeLogParser

hudson.plugins.git.GitChangeLogParser

public class GitChangeLogParser
extends ChangeLogParser

Parse the git log

Author:

Nigel Magnay

Constructor Summary

Constructors

Constructor	Description
GitChangeLogParser(boolean authorOrCommitter)	Deprecated. use #GitChangeLogParser(GitClient, boolean)
GitChangeLogParser(org.jenkinsci.plugins.gitclient.GitClient git, boolean authorOrCommitter)	Git client plugin 2.x silently truncated the first line of a commit message when showing the changelog summary in the 'Changes' page using command line git.

Method Summary

Modifier and Type	Method	Description
GitChangeSetList	parse(Run build, RepositoryBrowser<?> browser, File changelogFile)
List<GitChangeSet>	parse(InputStream changelog)
List<GitChangeSet>	parse(List<String> changelog)

Methods inherited from class hudson.scm.ChangeLogParser

parse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GitChangeLogParser

@Deprecated
public GitChangeLogParser(boolean authorOrCommitter)

Deprecated.

use #GitChangeLogParser(GitClient, boolean)

Git client plugin 2.x silently truncated the first line of a commit message when showing the changelog summary in the 'Changes' page using command line git. They did not truncate when using JGit. In order to simplify the git client plugin implementation, the truncation was removed from git client plugin 3.0. In order to retain backward compatibility, git plugin 4.0 became responsible to truncate the summary at the correct points. As a result of that change of responsibility, this class needs to know which implementation is being used so that it can adapt for appropriate compatibility.

Parameters:

authorOrCommitter - read author name instead of committer name if true

GitChangeLogParser

public GitChangeLogParser(org.jenkinsci.plugins.gitclient.GitClient git,
                          boolean authorOrCommitter)

Git client plugin 2.x silently truncated the first line of a commit message when showing the changelog summary in the 'Changes' page using command line git. They did not truncate when using JGit. In order to simplify the git client plugin implementation, the truncation was removed from git client plugin 3.0. In order to retain backward compatibility, git plugin 4.0 became responsible to truncate the summary at the correct points. As a result of that change of responsibility, this class needs to know which implementation is being used so that it can adapt for compatibility.

Parameters:

git - the GitClient implementation to be used by the change log parser

authorOrCommitter - read author name instead of committer name if true

Method Detail

parse

public List<GitChangeSet> parse(@NonNull
                                InputStream changelog)
                         throws IOException

Throws:

IOException

parse

public List<GitChangeSet> parse(@NonNull
                                List<String> changelog)

parse

public GitChangeSetList parse(Run build,
                              RepositoryBrowser<?> browser,
                              File changelogFile)
                       throws IOException

Overrides:

parse in class ChangeLogParser

Throws:

IOException