org.mockito.release.notes.contributors

Class Contributors

java.lang.Object

org.mockito.release.notes.contributors.Contributors

public class Contributors
extends java.lang.Object

Contributors based on some system outside of the vcs.

Constructor Summary

Constructors

Constructor and Description
Contributors()

Method Summary

Modifier and Type	Method and Description
static AllContributorsSerializer	getAllContributorsSerializer(java.io.File contributorsFile) Return Json serializer for all project contributors
static java.lang.String	getAllProjectContributorsFileName(java.lang.String buildDir) Generate file path where all project contributors are stored.
static GitHubContributorsProvider	getGitHubContributorsProvider(java.lang.String repository, java.lang.String readOnlyAuthToken) Fetches contributors from GitHub.
static java.lang.String	getLastContributorsFileName(java.lang.String buildDir, java.lang.String fromRev, java.lang.String toRevision) Generate file path where last contributors are stored.
static ContributorsSerializer	getLastContributorsSerializer(java.io.File contributorsFile) Return Json serializer for last last contributions

Methods inherited from class java.lang.Object

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

Constructor Detail

Contributors

public Contributors()

Method Detail

getGitHubContributorsProvider

public static GitHubContributorsProvider getGitHubContributorsProvider(java.lang.String repository,
                                                                       java.lang.String readOnlyAuthToken)

Fetches contributors from GitHub. Needs GitHub auth token.

Parameters:

repository - name of GitHub repository, for example: "mockito/mockito"

readOnlyAuthToken - the GitHub auth token

getLastContributorsFileName

public static java.lang.String getLastContributorsFileName(java.lang.String buildDir,
                                                           java.lang.String fromRev,
                                                           java.lang.String toRevision)

Generate file path where last contributors are stored.

Parameters:

buildDir - project build dir

fromRev - from revision or tag

toRevision - end revision or 'HEAD'

Returns:

file path

getAllProjectContributorsFileName

public static java.lang.String getAllProjectContributorsFileName(java.lang.String buildDir)

Generate file path where all project contributors are stored.

Parameters:

buildDir - project build dir

Returns:

file path

getLastContributorsSerializer

public static ContributorsSerializer getLastContributorsSerializer(java.io.File contributorsFile)

Return Json serializer for last last contributions

Parameters:

contributorsFile - file where last contributions are stored

Returns:

instance of ContributorsSerializer

getAllContributorsSerializer

public static AllContributorsSerializer getAllContributorsSerializer(java.io.File contributorsFile)

Return Json serializer for all project contributors

Parameters:

contributorsFile - file where all project contributions are stored

Returns:

instance of AllContributorsSerializer