net.openhft.chronicle.releasenotes.connector

Interface ReleaseConnector

All Superinterfaces:

AutoCloseable, Connector

public interface ReleaseConnector
extends Connector, AutoCloseable

Author:

Mislav Milicevic

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ReleaseConnector.AggregateReleaseOptions
static class	ReleaseConnector.BranchReleaseOptions
static class	ReleaseConnector.MilestoneReleaseOptions
static class	ReleaseConnector.ReleaseResult

Method Summary

Modifier and Type	Method and Description
default void	close()
default ReleaseConnector.ReleaseResult	createAggregatedRelease(String repository, String tag, List<ReleaseNote> releaseNotes) Creates and a release for a provided tag and returns a ReleaseConnector.ReleaseResult.
default ReleaseConnector.ReleaseResult	createAggregatedRelease(String repository, String tag, List<ReleaseNote> releaseNotes, boolean override) Deprecated.
ReleaseConnector.ReleaseResult	createAggregatedRelease(String repository, String tag, List<ReleaseNote> releaseNotes, ReleaseConnector.AggregateReleaseOptions releaseOptions) 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.
default ReleaseConnector.ReleaseResult	createAggregatedRelease(String repository, String tag, Map<String,List<String>> releases, boolean override) Deprecated.
ReleaseConnector.ReleaseResult	createAggregatedRelease(String repository, String tag, Map<String,List<String>> releases, ReleaseConnector.AggregateReleaseOptions releaseOptions) Creates and a release for a provided tag and returns a ReleaseConnector.ReleaseResult.
default ReleaseConnector.ReleaseResult	createReleaseFromBranch(String repository, String tag, String branch) Creates a release for a provided tag and returns a ReleaseConnector.ReleaseResult.
default ReleaseConnector.ReleaseResult	createReleaseFromBranch(String repository, String tag, String branch, List<String> ignoredLabels) Deprecated.
default ReleaseConnector.ReleaseResult	createReleaseFromBranch(String repository, String tag, String branch, List<String> ignoredLabels, boolean override) Deprecated.
ReleaseConnector.ReleaseResult	createReleaseFromBranch(String repository, String tag, String branch, ReleaseConnector.BranchReleaseOptions releaseOptions) Creates a release for a provided tag and returns a ReleaseConnector.ReleaseResult.
default ReleaseConnector.ReleaseResult	createReleaseFromBranch(String repository, String tag, String endTag, String branch) 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) Deprecated.
default ReleaseConnector.ReleaseResult	createReleaseFromBranch(String repository, String tag, String endTag, String branch, List<String> ignoredLabels, boolean override) Deprecated.
ReleaseConnector.ReleaseResult	createReleaseFromBranch(String repository, String tag, String endTag, String branch, ReleaseConnector.BranchReleaseOptions releaseOptions) Creates a release for a provided tag and returns a ReleaseConnector.ReleaseResult.
default ReleaseConnector.ReleaseResult	createReleaseFromMilestone(String repository, String tag, String milestone) 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) Deprecated.
default ReleaseConnector.ReleaseResult	createReleaseFromMilestone(String repository, String tag, String milestone, List<String> ignoredLabels, boolean override) Deprecated.
ReleaseConnector.ReleaseResult	createReleaseFromMilestone(String repository, String tag, String milestone, ReleaseConnector.MilestoneReleaseOptions milestoneReleaseOptions) Creates a release for a provided tag and returns a ReleaseConnector.ReleaseResult..
default ReleaseConnector.ReleaseResult	queryReleaseFromBranch(String repository, String tag, String branch) Queries an existing release for a provided tag and returns a ReleaseConnector.ReleaseResult.
ReleaseConnector.ReleaseResult	queryReleaseFromBranch(String repository, String tag, String branch, ReleaseConnector.BranchReleaseOptions releaseOptions) Queries an existing 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,
                                                       ReleaseConnector.BranchReleaseOptions releaseOptions)

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.

Parameters:

repository - reference

tag - name

branch - reference

Returns:

ReleaseConnector.ReleaseResult

createReleaseFromBranch

default ReleaseConnector.ReleaseResult createReleaseFromBranch(String repository,
                                                               String tag,
                                                               String branch)

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.

Parameters:

repository - reference

tag - name

branch - reference

Returns:

ReleaseConnector.ReleaseResult

createReleaseFromBranch

ReleaseConnector.ReleaseResult createReleaseFromBranch(String repository,
                                                       String tag,
                                                       String endTag,
                                                       String branch,
                                                       ReleaseConnector.BranchReleaseOptions releaseOptions)

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.

Parameters:

repository - reference

tag - name

endTag - name

branch - reference

Returns:

ReleaseConnector.ReleaseResult

createReleaseFromBranch

default ReleaseConnector.ReleaseResult createReleaseFromBranch(String repository,
                                                               String tag,
                                                               String endTag,
                                                               String branch)

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.

Parameters:

repository - reference

tag - name

endTag - name

branch - reference

Returns:

ReleaseConnector.ReleaseResult

createReleaseFromMilestone

ReleaseConnector.ReleaseResult createReleaseFromMilestone(String repository,
                                                          String tag,
                                                          String milestone,
                                                          ReleaseConnector.MilestoneReleaseOptions milestoneReleaseOptions)

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.

Parameters:

repository - reference

tag - name

milestone - issues to include in the release

Returns:

ReleaseConnector.ReleaseResult

createReleaseFromMilestone

default ReleaseConnector.ReleaseResult createReleaseFromMilestone(String repository,
                                                                  String tag,
                                                                  String milestone)

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.

Parameters:

repository - reference

tag - name

milestone - issues to include in the release

Returns:

ReleaseConnector.ReleaseResult

createAggregatedRelease

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

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

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,
                                                       ReleaseConnector.AggregateReleaseOptions releaseOptions)

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

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

queryReleaseFromBranch

ReleaseConnector.ReleaseResult queryReleaseFromBranch(String repository,
                                                      String tag,
                                                      String branch,
                                                      ReleaseConnector.BranchReleaseOptions releaseOptions)

Queries an existing 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.

Parameters:

repository - reference

tag - name

branch - reference

Returns:

ReleaseConnector.ReleaseResult

queryReleaseFromBranch

default ReleaseConnector.ReleaseResult queryReleaseFromBranch(String repository,
                                                              String tag,
                                                              String branch)

Queries an existing 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.

Parameters:

repository - reference

tag - name

branch - reference

Returns:

ReleaseConnector.ReleaseResult

close

default void close()
            throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

createReleaseFromBranch

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

Deprecated.

createReleaseFromBranch

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

Deprecated.

createReleaseFromBranch

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

Deprecated.

createReleaseFromBranch

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

Deprecated.

createReleaseFromMilestone

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

Deprecated.

createReleaseFromMilestone

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

Deprecated.

createAggregatedRelease

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

Deprecated.

createAggregatedRelease

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

Deprecated.