net.openhft.chronicle.releasenotes.connector

Interface ReleaseConnector

All Superinterfaces:

Connector

public interface ReleaseConnector
extends Connector

Author:

Mislav Milicevic

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ReleaseConnector.ReleaseResult

Method Summary

Modifier and Type	Method and Description
default ReleaseConnector.ReleaseResult	createAggregatedRelease(String repository, String tag, List<ReleaseNote> releaseNotes) Creates and a release for a provided tag and returns a ReleaseConnector.ReleaseResult.
ReleaseConnector.ReleaseResult	createAggregatedRelease(String repository, String tag, List<ReleaseNote> releaseNotes, boolean override) Creates and a release for a provided tag and returns a ReleaseConnector.ReleaseResult.
default ReleaseConnector.ReleaseResult	createAggregatedRelease(String repository, String tag, Map<String,List<String>> releases) Creates and a release for a provided tag and returns a ReleaseConnector.ReleaseResult.
ReleaseConnector.ReleaseResult	createAggregatedRelease(String repository, String tag, Map<String,List<String>> releases, boolean override) Creates and a release for a provided tag and returns a ReleaseConnector.ReleaseResult.
default ReleaseConnector.ReleaseResult	createReleaseFromBranch(String repository, String tag, String branch, List<String> ignoredLabels) Creates a release for a provided tag and returns a ReleaseConnector.ReleaseResult.
ReleaseConnector.ReleaseResult	createReleaseFromBranch(String repository, String tag, String branch, List<String> ignoredLabels, boolean override) Creates a release for a provided tag and returns a ReleaseConnector.ReleaseResult.
default ReleaseConnector.ReleaseResult	createReleaseFromBranch(String repository, String tag, String endTag, String branch, List<String> ignoredLabels) Creates a release for a provided tag and returns a ReleaseConnector.ReleaseResult.
ReleaseConnector.ReleaseResult	createReleaseFromBranch(String repository, String tag, String endTag, String branch, List<String> ignoredLabels, boolean override) Creates a release for a provided tag and returns a ReleaseConnector.ReleaseResult.
default ReleaseConnector.ReleaseResult	createReleaseFromMilestone(String repository, String tag, String milestone, List<String> ignoredLabels) Creates a release for a provided tag and returns a ReleaseConnector.ReleaseResult.
ReleaseConnector.ReleaseResult	createReleaseFromMilestone(String repository, String tag, String milestone, List<String> ignoredLabels, boolean override) Creates a release for a provided tag and returns a ReleaseConnector.ReleaseResult..

Methods inherited from interface net.openhft.chronicle.releasenotes.connector.Connector

getKey

Method Detail

createReleaseFromBranch

ReleaseConnector.ReleaseResult createReleaseFromBranch(String repository,
                                                       String tag,
                                                       String branch,
                                                       List<String> ignoredLabels,
                                                       boolean override)

Creates a release for a provided tag and returns a ReleaseConnector.ReleaseResult. The provided branch is used as a reference to generate the contents of the release notes associated with this release. The contents of the release are all issues contained between the provided tag and the tag that chronologically came before it.

If ignoredLabels is not null or is not empty, then all of the issues which contain one of the provided labels are ignored in the release note generation process.

In case a release for the provided tag already exists and override is true, the existing release will be updated with the contents of the newly generated release. Otherwise, a RuntimeException will be thrown.

Parameters:

repository - reference

tag - name

branch - reference

ignoredLabels - a list of ignored labels

override - an existing release

Returns:

ReleaseConnector.ReleaseResult

createReleaseFromBranch

default ReleaseConnector.ReleaseResult createReleaseFromBranch(String repository,
                                                               String tag,
                                                               String branch,
                                                               List<String> ignoredLabels)

Creates a release for a provided tag and returns a ReleaseConnector.ReleaseResult. The provided branch is used as a reference to generate the contents of the release notes associated with this release. The contents of the release are all issues contained between the provided tag and the tag that chronologically came before it.

If ignoredLabels is not null or is not empty, then all of the issues which contain one of the provided labels are ignored in the release note generation process.

Parameters:

repository - reference

tag - name

branch - reference

ignoredLabels - a list of ignored labels

Returns:

ReleaseConnector.ReleaseResult

createReleaseFromBranch

ReleaseConnector.ReleaseResult createReleaseFromBranch(String repository,
                                                       String tag,
                                                       String endTag,
                                                       String branch,
                                                       List<String> ignoredLabels,
                                                       boolean override)

Creates a release for a provided tag and returns a ReleaseConnector.ReleaseResult. The provided branch is used as a reference to generate the contents of the release notes associated with this release. The contents of the release are all issues contained between the provided tag and endTag.

If ignoredLabels is not null or is not empty, then all of the issues which contain one of the provided labels are ignored in the release note generation process.

In case a release for the provided tag already exists and override is true, the existing release will be updated with the contents of the newly generated release. Otherwise, a RuntimeException will be thrown.

Parameters:

repository - reference

tag - name

endTag - name

branch - reference

ignoredLabels - a list of ignored labels

override - an existing release

Returns:

ReleaseConnector.ReleaseResult

createReleaseFromBranch

default ReleaseConnector.ReleaseResult createReleaseFromBranch(String repository,
                                                               String tag,
                                                               String endTag,
                                                               String branch,
                                                               List<String> ignoredLabels)

Creates a release for a provided tag and returns a ReleaseConnector.ReleaseResult. The provided branch is used as a reference to generate the contents of the release notes associated with this release. The contents of the release are all issues contained between the provided tag and endTag.

If ignoredLabels is not null or is not empty, then all of the issues which contain one of the provided labels are ignored in the release note generation process.

Parameters:

repository - reference

tag - name

endTag - name

branch - reference

ignoredLabels - a list of ignored labels

Returns:

ReleaseConnector.ReleaseResult

createReleaseFromMilestone

ReleaseConnector.ReleaseResult createReleaseFromMilestone(String repository,
                                                          String tag,
                                                          String milestone,
                                                          List<String> ignoredLabels,
                                                          boolean override)

Creates a release for a provided tag and returns a ReleaseConnector.ReleaseResult.. The provided milestone is used as a reference to generate the contents of the release notes associated with this release.

If ignoredLabels is not null or is not empty, then all of the issues which contain one of the provided labels are ignored in the release note generation process.

In case a release for the provided tag already exists and override is true, the existing release will be updated with the contents of the newly generated release. Otherwise, a RuntimeException will be thrown.

Parameters:

repository - reference

tag - name

milestone - issues to include in the release

ignoredLabels - a list of ignored labels

override - an existing release

Returns:

ReleaseConnector.ReleaseResult

createReleaseFromMilestone

default ReleaseConnector.ReleaseResult createReleaseFromMilestone(String repository,
                                                                  String tag,
                                                                  String milestone,
                                                                  List<String> ignoredLabels)

Creates a release for a provided tag and returns a ReleaseConnector.ReleaseResult. The provided milestone is used as a reference to generate the contents of the release notes associated with this release.

If ignoredLabels is not null or is not empty, then all of the issues which contain one of the provided labels are ignored in the release note generation process.

Parameters:

repository - reference

tag - name

milestone - issues to include in the release

ignoredLabels - a list of ignored labels

Returns:

ReleaseConnector.ReleaseResult

createAggregatedRelease

ReleaseConnector.ReleaseResult createAggregatedRelease(String repository,
                                                       String tag,
                                                       Map<String,List<String>> releases,
                                                       boolean override)

Creates and a release for a provided tag and returns a ReleaseConnector.ReleaseResult. The provided releases are used as a reference to generate the contents of the release notes associated with this aggregated release.

In case a release for the provided tag already exists and override is true, the existing release will be updated with the contents of the newly generated release. Otherwise, a RuntimeException will be thrown.

Parameters:

repository - reference

tag - name

releases - to include in the aggregated release

override - an existing release

Returns:

ReleaseConnector.ReleaseResult

createAggregatedRelease

default ReleaseConnector.ReleaseResult createAggregatedRelease(String repository,
                                                               String tag,
                                                               Map<String,List<String>> releases)

Creates and a release for a provided tag and returns a ReleaseConnector.ReleaseResult. The provided releases are used as a reference to generate the contents of the release notes associated with this aggregated release.

Parameters:

repository - reference

tag - name

releases - to include in the aggregated release

Returns:

ReleaseConnector.ReleaseResult

createAggregatedRelease

ReleaseConnector.ReleaseResult createAggregatedRelease(String repository,
                                                       String tag,
                                                       List<ReleaseNote> releaseNotes,
                                                       boolean override)

Creates and a release for a provided tag and returns a ReleaseConnector.ReleaseResult. The provided releaseNotes are used as a reference to generate the aggregated release.

In case a release for the provided tag already exists and override is true, the existing release will be updated with the contents of the newly generated release. Otherwise, a RuntimeException will be thrown.

Parameters:

repository - reference

tag - name

releaseNotes - to include in the aggregated release

override - an existing release

Returns:

ReleaseConnector.ReleaseResult

createAggregatedRelease

default ReleaseConnector.ReleaseResult createAggregatedRelease(String repository,
                                                               String tag,
                                                               List<ReleaseNote> releaseNotes)

Creates and a release for a provided tag and returns a ReleaseConnector.ReleaseResult. The provided releaseNotes are used as a reference to generate the aggregated release.

Parameters:

repository - reference

tag - name

releaseNotes - to include in the aggregated release

Returns:

ReleaseConnector.ReleaseResult