GitChangelogApi (git-changelog-lib 1.23 API)

java.lang.Object
- se.bjurr.gitchangelog.api.GitChangelogApi

public class GitChangelogApi
extends java.lang.Object

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Changelog`	`getChangelog()` Get the changelog as data object.
`Settings`	`getSettings()`
`static GitChangelogApi`	`gitChangelogApiBuilder()`
`java.lang.String`	`render()` Get the changelog as rendered string.
`void`	`toFile(java.lang.String filePath)` Write changelog to file.
`void`	`toMediaWiki(java.lang.String username, java.lang.String password, java.lang.String url, java.lang.String title)` Create MediaWiki page with changelog.
`GitChangelogApi`	`withCustomIssue(java.lang.String name, java.lang.String pattern, java.lang.String link)` Custom issues are added to support any kind of issue management, perhaps something that is internal to your project.
`GitChangelogApi`	`withDateFormat(java.lang.String dateFormat)` Format of dates, see `SimpleDateFormat`.
`GitChangelogApi`	`withExtendedVariables(java.util.Map<java.lang.String,java.lang.Object> extendedVariables)` Extended variables is simply a key-value mapping of variables that are made available in the template.
`GitChangelogApi`	`withFromCommit(java.lang.String fromCommit)` Include all commits from here.
`GitChangelogApi`	`withFromRef(java.lang.String fromBranch)` Include all commits from here.
`GitChangelogApi`	`withFromRepo(java.lang.String fromRepo)` Folder where repo lives.
`GitChangelogApi`	`withGitHubApi(java.lang.String gitHubApi)` URL pointing at GitHub API.
`GitChangelogApi`	`withGitHubIssuePattern(java.lang.String gitHubIssuePattern)` Pattern to recognize GitHub:s.
`GitChangelogApi`	`withIgnoreCommitsWithMesssage(java.lang.String ignoreCommitsIfMessageMatches)` A regular expression that is evaluated on the commit message of each commit.
`GitChangelogApi`	`withJiraIssuePattern(java.lang.String jiraIssuePattern)` Pattern to recognize JIRA:s.
`GitChangelogApi`	`withJiraPassword(java.lang.String string)` Authenticate to JIRA.
`GitChangelogApi`	`withJiraServer(java.lang.String jiraServer)` URL pointing at your JIRA server.
`GitChangelogApi`	`withJiraUsername(java.lang.String string)` Authenticate to JIRA.
`GitChangelogApi`	`withNoIssueName(java.lang.String noIssueName)` This is a "virtual issue" that is added to `Changelog.getIssues()`.
`GitChangelogApi`	`withReadableTagName(java.lang.String readableTagName)` Your tags may look something like `git-changelog-maven-plugin-1.6`.
`GitChangelogApi`	`withRemoveIssueFromMessageArgument(boolean removeIssueFromMessage)` If true, the changelog will not contain the issue in the commit comment.
`GitChangelogApi`	`withSettings(java.net.URL url)` `Settings`.
`GitChangelogApi`	`withTemplateContent(java.lang.String templateContent)` Use string as template.
`GitChangelogApi`	`withTemplatePath(java.lang.String templatePath)` Path of template-file to use.
`GitChangelogApi`	`withTimeZone(java.lang.String timeZone)` When date of commits are translated to a string, this timezone is used.
`GitChangelogApi`	`withToCommit(java.lang.String toCommit)` Include all commits to here.
`GitChangelogApi`	`withToRef(java.lang.String toBranch)` Include all commits to this reference.
`GitChangelogApi`	`withUntaggedName(java.lang.String untaggedName)` Some commits may not be included in any tag.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - gitChangelogApiBuilder
```
public static GitChangelogApi gitChangelogApiBuilder()
```
  - withSettings
```
public GitChangelogApi withSettings(java.net.URL url)
```
    Settings.
  - withFromRepo
```
public GitChangelogApi withFromRepo(java.lang.String fromRepo)
```
    Folder where repo lives.
  - withFromRef
```
public GitChangelogApi withFromRef(java.lang.String fromBranch)
```
    Include all commits from here. Any tag or branch name.
  - withToRef
```
public GitChangelogApi withToRef(java.lang.String toBranch)
```
    Include all commits to this reference. Any tag or branch name. There is a constant for master here: reference{GitChangelogApiConstants#REF_MASTER}.
  - withFromCommit
```
public GitChangelogApi withFromCommit(java.lang.String fromCommit)
```
    Include all commits from here. Any commit hash. There is a constant pointing at the first commit here: reference{GitChangelogApiConstants#ZERO_COMMIT}.
  - withToCommit
```
public GitChangelogApi withToCommit(java.lang.String toCommit)
```
    Include all commits to here. Any commit hash.
  - withIgnoreCommitsWithMesssage
```
public GitChangelogApi withIgnoreCommitsWithMesssage(java.lang.String ignoreCommitsIfMessageMatches)
```
    A regular expression that is evaluated on the commit message of each commit. If it matches, the commit will be filtered out and not included in the changelog.
    
    To ignore tags creted by Maven and Gradle release plugins, perhaps you want this:
    ^\[maven-release-plugin\].*|^\[Gradle Release Plugin\].*|^Merge.*
    
    Remember to escape it, if added to the json-file it would look like this:
    ^\\[maven-release-plugin\\].*|^\\[Gradle Release Plugin\\].*|^Merge.*
  - withUntaggedName
```
public GitChangelogApi withUntaggedName(java.lang.String untaggedName)
```
    Some commits may not be included in any tag. Commits that not released yet may not be tagged. This is a "virtual tag", added to Changelog.getTags(), that includes those commits. A fitting value may be "Next release".
  - withTemplatePath
```
public GitChangelogApi withTemplatePath(java.lang.String templatePath)
```
    Path of template-file to use. It is a Mustache (https://mustache.github.io/) template. Supplied with the context of Changelog.
  - withTemplateContent
```
public GitChangelogApi withTemplateContent(java.lang.String templateContent)
```
    Use string as template. withTemplatePath(java.lang.String).
  - withReadableTagName
```
public GitChangelogApi withReadableTagName(java.lang.String readableTagName)
```
    Your tags may look something like git-changelog-maven-plugin-1.6. But in the changelog you just want 1.6. With this regular expression, the numbering can be extracted from the tag name.
    /([^/]+?)$
  - withDateFormat
```
public GitChangelogApi withDateFormat(java.lang.String dateFormat)
```
    Format of dates, see SimpleDateFormat.
  - withNoIssueName
```
public GitChangelogApi withNoIssueName(java.lang.String noIssueName)
```
    This is a "virtual issue" that is added to Changelog.getIssues(). It contains all commits that has no issue in the commit comment. This could be used as a "wall of shame" listing commiters that did not tag there commits with an issue.
  - withTimeZone
```
public GitChangelogApi withTimeZone(java.lang.String timeZone)
```
    When date of commits are translated to a string, this timezone is used.
    UTC
  - withRemoveIssueFromMessageArgument
```
public GitChangelogApi withRemoveIssueFromMessageArgument(boolean removeIssueFromMessage)
```
    If true, the changelog will not contain the issue in the commit comment. If your changelog is grouped by issues, you may want this to be true. If not grouped by issue, perhaps false.
  - withJiraServer
```
public GitChangelogApi withJiraServer(java.lang.String jiraServer)
```
    URL pointing at your JIRA server. When configured, the Issue.getTitle() will be populated with title from JIRA.
    https://jiraserver/jira
  - withJiraIssuePattern
```
public GitChangelogApi withJiraIssuePattern(java.lang.String jiraIssuePattern)
```
    Pattern to recognize JIRA:s. \b[a-zA-Z]([a-zA-Z]+)-([0-9]+)\b
    
    Or escaped if added to json-file:
    \\b[a-zA-Z]([a-zA-Z]+)-([0-9]+)\\b
  - withJiraUsername
```
public GitChangelogApi withJiraUsername(java.lang.String string)
```
    Authenticate to JIRA.
  - withJiraPassword
```
public GitChangelogApi withJiraPassword(java.lang.String string)
```
    Authenticate to JIRA.
  - withGitHubApi
```
public GitChangelogApi withGitHubApi(java.lang.String gitHubApi)
```
    URL pointing at GitHub API. When configured, the Issue.getTitle() will be populated with title from GitHub.
    https://api.github.com/repos/tomasbjerre/git-changelog-lib
  - withGitHubIssuePattern
```
public GitChangelogApi withGitHubIssuePattern(java.lang.String gitHubIssuePattern)
```
    Pattern to recognize GitHub:s. #([0-9]+)
  - withCustomIssue
```
public GitChangelogApi withCustomIssue(java.lang.String name,
                                       java.lang.String pattern,
                                       java.lang.String link)
```
    Custom issues are added to support any kind of issue management, perhaps something that is internal to your project. See SettingsIssue.
  - withExtendedVariables
```
public GitChangelogApi withExtendedVariables(java.util.Map<java.lang.String,java.lang.Object> extendedVariables)
```
    Extended variables is simply a key-value mapping of variables that are made available in the template. Is used, for example, by the Bitbucket plugin to supply some internal variables to the changelog context.
  - toFile
```
public void toFile(java.lang.String filePath)
```
    Write changelog to file.
  - toMediaWiki
```
public void toMediaWiki(java.lang.String username,
                        java.lang.String password,
                        java.lang.String url,
                        java.lang.String title)
```
    Create MediaWiki page with changelog.
  - getChangelog
```
public Changelog getChangelog()
```
    Get the changelog as data object.
  - render
```
public java.lang.String render()
```
    Get the changelog as rendered string.
  - getSettings
```
public Settings getSettings()
```

Class GitChangelogApi

Method Summary

Methods inherited from class java.lang.Object

Method Detail

gitChangelogApiBuilder

withSettings

withFromRepo

withFromRef

withToRef

withFromCommit

withToCommit

withIgnoreCommitsWithMesssage

withUntaggedName

withTemplatePath

withTemplateContent

withReadableTagName

withDateFormat

withNoIssueName

withTimeZone

withRemoveIssueFromMessageArgument

withJiraServer

withJiraIssuePattern

withJiraUsername

withJiraPassword

withGitHubApi

withGitHubIssuePattern

withCustomIssue

withExtendedVariables

toFile

toMediaWiki

getChangelog

render

getSettings