net.openhft.chronicle.releasenotes.connector.github

Class GitHubReleaseConnector

java.lang.Object

net.openhft.chronicle.releasenotes.connector.github.GitHubReleaseConnector

All Implemented Interfaces:

AutoCloseable, Connector, ReleaseConnector

public final class GitHubReleaseConnector
extends Object
implements ReleaseConnector

Author:

Mislav Milicevic

Nested Class Summary

Nested classes/interfaces inherited from interface net.openhft.chronicle.releasenotes.connector.ReleaseConnector

ReleaseConnector.AggregateReleaseOptions, ReleaseConnector.BranchReleaseOptions, ReleaseConnector.MilestoneReleaseOptions, ReleaseConnector.ReleaseResult

Constructor Summary

Constructors

Constructor and Description
GitHubReleaseConnector(String token)
GitHubReleaseConnector(String token, org.slf4j.Logger logger)

Method Summary

Modifier and Type	Method and Description
void	close()
ReleaseConnector.ReleaseResult	createAggregatedRelease(String repository, String tag, List<net.openhft.chronicle.releasenotes.model.ReleaseNote> releaseNotes, ReleaseConnector.AggregateReleaseOptions releaseOptions)
ReleaseConnector.ReleaseResult	createAggregatedRelease(String repository, String tag, Map<String,List<String>> releases, ReleaseConnector.AggregateReleaseOptions releaseOptions)
ReleaseConnector.ReleaseResult	createReleaseFromBranch(String repository, String tag, String branch, ReleaseConnector.BranchReleaseOptions releaseOptions)
ReleaseConnector.ReleaseResult	createReleaseFromBranch(String repository, String tag, String endTag, String branch, ReleaseConnector.BranchReleaseOptions releaseOptions)
ReleaseConnector.ReleaseResult	createReleaseFromMilestone(String repository, String tag, String milestone, ReleaseConnector.MilestoneReleaseOptions releaseOptions)
Class<? extends ConnectorProviderKey>	getKey()
ReleaseConnector.ReleaseResult	queryReleaseFromBranch(String repository, String tag, String branch, ReleaseConnector.BranchReleaseOptions releaseOptions)

Methods inherited from class java.lang.Object

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

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

createAggregatedRelease, createAggregatedRelease, createAggregatedRelease, createAggregatedRelease, createReleaseFromBranch, createReleaseFromBranch, createReleaseFromBranch, createReleaseFromBranch, createReleaseFromBranch, createReleaseFromBranch, createReleaseFromMilestone, createReleaseFromMilestone, createReleaseFromMilestone, queryReleaseFromBranch

Constructor Detail

GitHubReleaseConnector

public GitHubReleaseConnector(String token)
                       throws IOException

Throws:

IOException

GitHubReleaseConnector

public GitHubReleaseConnector(String token,
                              org.slf4j.Logger logger)
                       throws IOException

Throws:

IOException

Method Detail

createReleaseFromBranch

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

Specified by:

createReleaseFromBranch in interface ReleaseConnector

createReleaseFromBranch

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

Specified by:

createReleaseFromBranch in interface ReleaseConnector

createReleaseFromMilestone

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

Specified by:

createReleaseFromMilestone in interface ReleaseConnector

createAggregatedRelease

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

Specified by:

createAggregatedRelease in interface ReleaseConnector

createAggregatedRelease

public ReleaseConnector.ReleaseResult createAggregatedRelease(String repository,
                                                              String tag,
                                                              List<net.openhft.chronicle.releasenotes.model.ReleaseNote> releaseNotes,
                                                              ReleaseConnector.AggregateReleaseOptions releaseOptions)

Specified by:

createAggregatedRelease in interface ReleaseConnector

queryReleaseFromBranch

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

Specified by:

queryReleaseFromBranch in interface ReleaseConnector

getKey

public Class<? extends ConnectorProviderKey> getKey()

Specified by:

getKey in interface Connector

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ReleaseConnector

Throws:

Exception