Index (mockito-release-tools 0.5.0 API)

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

addAllContributors(Set<Contributor>) - Method in ContributorsSet
addContributor(Contributor) - Method in ContributorsSet
appendToTop(String, File) - Method in FileUtil: Appends content to the top of the file.
apply(Project) - Method in BintrayPlugin
apply(Project) - Method in DefaultBaseJavaLibraryPlugin
apply(Project) - Method in DefaultContinuousDeliveryPlugin
apply(Project) - Method in DefaultJavaLibraryPlugin
apply(Project) - Method in DefaultReleaseNotesPlugin
apply(Project) - Method in DefaultVersioningPlugin
apply(Project) - Method in ReleaseWorkflowPlugin
ArgumentValidation - Class in org.mockito.release.util: Utility for validation of arguments

B

BaseJavaLibraryPlugin - Interface in org.mockito.release.gradle: Intended to be applied in individual Java submodule.
BintrayPlugin - Class in org.mockito.release.internal.gradle
buildNotes(String, String, String, Map<String, String>) - Method in NotesBuilder: Release notes text for contributions between given versions.
bumpVersion(boolean) - Method in VersionFile: Increments version number in the backing object (typically a file) and returns incremented value.
bumpVersionFile() - Method in DefaultBumpVersionFileTask
BumpVersionFileTask - Interface in org.mockito.release.gradle: Increments version in specified file.

C

close(Closeable) - Method in IOUtil: Closes the target.
Commit - Interface in org.mockito.release.notes.model: VCS change, a commit
CommonSettings - Class in org.mockito.release.internal.gradle.util
compareBinaries(Closure<File>, Closure<File>) - Method in PublicationsComparator: Sets files for comparison
compareBinaries(Closure<File>, Closure<File>) - Method in PublicationsComparatorTask
comparePoms(Closure<String>, Closure<String>) - Method in PublicationsComparator: Sets poms for comparison
comparePoms(Closure<String>, Closure<String>) - Method in PublicationsComparatorTask
comparePublications() - Method in PublicationsComparatorTask
configureLazily(Task, Runnable) - Method in LazyConfigurer: Lazily configures given task, only when the task is included in the task graph
containsRevision(JsonObject, String) - Method in GitHubCommitsJSON
ContinuousDeliveryPlugin - Interface in org.mockito.release.gradle: Opinionated continuous delivery setup based on Mockito project.
Contribution - Interface in org.mockito.release.notes.model: VCS contribution, author + all commits.
ContributionSet - Interface in org.mockito.release.notes.model: A set of contributions
ContributionsProvider - Interface in org.mockito.release.notes.vcs: Knows the contributions
Contributor - Interface in org.mockito.release.notes.model
Contributors - Class in org.mockito.release.notes.contributors: Contributors based on some system outside of the vcs.
ContributorsProvider - Interface in org.mockito.release.notes.contributors
ContributorsSet - Interface in org.mockito.release.notes.contributors
customizePom(Project, MavenPublication) - Method in PomCustomizer: Customizes the pom.

D

DateFormat - Class in org.mockito.release.notes.internal: Date parsing and formatting utilities
DefaultBaseJavaLibraryPlugin - Class in org.mockito.release.internal.gradle: Please keep documentation up to date at BaseJavaLibraryPlugin
DefaultBumpVersionFileTask - Class in org.mockito.release.internal.gradle
DefaultContinuousDeliveryPlugin - Class in org.mockito.release.internal.gradle: Please keep documentation up to date at ContinuousDeliveryPlugin
DefaultContributor - Class in org.mockito.release.notes.contributors
defaultFormatter(Map<String, String>) - Method in ReleaseNotesFormatters: Returns the default formatter for version notes data
DefaultImprovement - Class in org.mockito.release.notes.internal: Simple POJO that contains all the information of an improvement
DefaultImprovement(Long, String, String, Collection<String>, boolean) - Constructor in DefaultImprovement
DefaultJavaLibraryPlugin - Class in org.mockito.release.internal.gradle
DefaultReleaseNotesData - Class in org.mockito.release.notes.internal
DefaultReleaseNotesData(String, Date, ContributionSet, Collection<Improvement>, ContributorsSet, String, String) - Constructor in DefaultReleaseNotesData
DefaultReleaseNotesExtension - Class in org.mockito.release.internal.gradle
DefaultReleaseNotesExtension(File, String) - Constructor in DefaultReleaseNotesExtension
DefaultReleaseNotesPlugin - Class in org.mockito.release.internal.gradle: -------------------------- ****** IMPORTANT ******** --------------------------
DefaultVersioningPlugin - Class in org.mockito.release.internal.gradle
deserialize() - Method in ReleaseNotesSerializer
detailedFormatter(String, Map<String, String>, String) - Method in ReleaseNotesFormatters: Returns the detailed formatter intended to use for all releases

E

EnvVariables - Class in org.mockito.release.internal.gradle.util
Exec - Class in org.mockito.release.exec: Process execution services
execTask(Project, String, boolean, Action<Exec>) - Method in CommonSettings: Creates exec task with preconfigured defaults
ExtContainer - Class in org.mockito.release.internal.gradle.util
ExtContainer(Project) - Constructor in ExtContainer

F

FileUtil - Class in org.mockito.release.internal.gradle.util: File utilities.
findByAuthorName(String) - Method in ContributorsSet
firstLine(File) - Method in FileUtil: Returns first line of the file.
formatDate(Date) - Method in DateFormat: Formats date to most reasonable format to show on the release notes
formatDateToLocalTime(Date) - Method in DateFormat: Formats date to local timezone to shows in debug logs
formatReleaseNotes(Collection<ReleaseNotesData>) - Method in MultiReleaseNotesFormatter: Formats release notes data for all releases
formatVersion(ReleaseNotesData) - Method in SingleReleaseNotesFormatter: Formats the version notes data
formatVersion(ReleaseNotesData) - Method in TabularFormatter

G

generateReleaseNotes() - Method in NotableReleaseNotesFetcherTask
generateReleaseNotes() - Method in NotableReleaseNotesGeneratorTask
generateReleaseNotesData(String, Collection<String>, String, Collection<String>, boolean) - Method in ReleaseNotesGenerator: Generates release notes data model.
get(K) - Method in MultiMap: If the key does not exist, null is returned
getAllCommits() - Method in ContributionSet: All commits in given contribution set, spanning all authors
getAllTickets() - Method in ContributionSet: All tickets referenced in commit messages
getAuthorCount() - Method in ContributionSet: All unique authors of this set of contributions.
getAuthorEmail() - Method in Commit: Author identifier.
getAuthorName() - Method in Commit: Author display name.
getAuthorName() - Method in Contribution: The name of the author
getCollection(Object) - Method in ExtContainer
getCommitId() - Method in Commit: Commit identifier.
getCommits() - Method in Contribution: Commits
getCompleteReleaseNotes() - Method in DefaultReleaseNotesExtension
getConfigurer(Project) - Method in LazyConfigurer: Gets the configurer for the project.
getContributions() - Method in ContributionSet: All contributions in the set.
getContributions() - Method in DefaultReleaseNotesData
getContributions() - Method in ReleaseNotesData: Contributions (authors and commits from VCS)
getContributionsBetween(String, String) - Method in ContributionsProvider: Provides contributions between specified versions
getContributionsProvider(ProcessRunner) - Method in Vcs: Provides means to get contributions.
getContributors() - Method in DefaultReleaseNotesData
getContributors() - Method in ReleaseNotesData: Contributors (authors and links to www pages)
getCurrentBranch() - Method in ExtContainer: Returns the branch to work on by checking the env variable 'TRAVIS_BRANCH'
getDate() - Method in DefaultReleaseNotesData
getDate() - Method in ReleasedVersion: Release date
getDate() - Method in ReleaseNotesData: Date of the release
getDetailedReleaseNotesLink() - Method in NotesGeneration
getEnv(String) - Method in EnvVariables: Provides env variables and validates presence.
getGitGenericEmail() - Method in ExtContainer: Generic git email to be used for commits, for example "mockito.release.tools@gmail.com"
getGitGenericUser() - Method in ExtContainer: Generic git user to be used for commits, for example "mockito.release.tools"
getGitGenericUserNotation() - Method in ExtContainer: Returns Git generic user notation based on settings, for example: "Mockito Release Tools <mockito.release.tools@gmail.com>"
getGitHubContibutorsProvider(String, String) - Method in Contributors: Fetches contribiutors from GitHub.
getGitHubLabels() - Method in NotesGeneration
getGitHubProvider(String, String) - Method in Improvements: Fetches tickets from GitHub.
getGitHubReadOnlyAuthToken() - Method in ExtContainer: GitHub read only auth token
getGitHubReadOnlyAuthToken() - Method in NotesGeneration
getGitHubRepository() - Method in ExtContainer: GitHub repository name, for example: "mockito/mockito"
getGitHubRepository() - Method in NotesGeneration
getGitWorkingDir() - Method in NotesGeneration
getHeadVersion() - Method in NotesGeneration
getId() - Method in DefaultImprovement
getId() - Method in Improvement: Identifier of the improvement.
getImprovements() - Method in DefaultReleaseNotesData
getImprovements(ContributionSet, Collection<String>, boolean) - Method in ImprovementsProvider: Returns improvements that are referenced from given contribution set.
getImprovements() - Method in ReleaseNotesData: Improvements (issues, pull requests from issue tracker)
getIntroductionText() - Method in NotesGeneration
getLabels() - Method in DefaultImprovement
getLabels() - Method in Improvement: Labels of this improvement.
getLogin() - Method in Contributor: The login of the author.
getLogin() - Method in DefaultContributor
getMap(Object) - Method in ExtContainer
getMessage() - Method in Commit: Commit message
getName() - Method in Contributor: The name of the author.
getName() - Method in DefaultContributor
getNotableReleaseNotesFile() - Method in ExtContainer: Notable release notes file, for example "docs/notable-release-notes.md"
getNotableVersions() - Method in VersionFile: Returns notable versions
getNotesGeneration() - Method in NotableReleaseNotesFetcherTask
getNotesGeneration() - Method in NotableReleaseNotesGeneratorTask
getOutputFile() - Method in NotesGeneration
getPreviousRev() - Method in ReleasedVersion: Nullable, previous revision (tag)
getPreviousVersion() - Method in DefaultReleaseNotesExtension
getPreviousVersion() - Method in PreviousVersion: The previous version
getPreviousVersion() - Method in ReleaseNotesExtension: Returns previous version based on the release notes file.
getPreviousVersionVcsTag() - Method in DefaultReleaseNotesData
getPreviousVersionVcsTag() - Method in ReleaseNotesData: The vcs addressable tag of previous version
getProcessRunner(File) - Method in Exec: Provides process runner for given working dir
getProfileUrl() - Method in Contributor: The URL to author page.
getProfileUrl() - Method in DefaultContributor
getQuietGitPushArgs() - Method in ExtContainer: Quiet command line to be used to perform git push
getReleasableBranchRegex() - Method in ExtContainer: Regex to be used to identify branches that entitled to be released, for example "master|release/
getReleaseDateProvider(ProcessRunner) - Method in Vcs: Provides means to get release versions
getReleasedVersions(String, Date, Collection<String>, String) - Method in ReleasedVersionsProvider: Provides release versions information, with dates for given versions.
getReleaseNotes(String) - Method in DefaultReleaseNotesExtension
getReleaseNotes(String) - Method in ReleaseNotesExtension: Generates and returns incremental release notes text that can be appended to the release notes file.
getReleaseNotesFile() - Method in ExtContainer: Release notes file relative path, for example: "docs/release-notes.md"
getRev() - Method in ReleasedVersion: vcs addressable revision (tag)
getRevisionForTagOrRevision(String) - Method in GitRevisionProvider
getRevisionForTagOrRevision(String) - Method in RevisionProvider: Convert tag (or revision) to revision number
getRevisionProvider(ProcessRunner) - Method in Vcs
getString(Object) - Method in ExtContainer
getTag() - Method in ExtContainer: Tag name to be used, "v" + project.version
getTagPrefix() - Method in NotesGeneration
getTargetVersions() - Method in NotesGeneration
getTemporarySerializedNotesFile() - Method in NotesGeneration
getTickets() - Method in Commit: Tickets referenced by the commit.
getTitle() - Method in DefaultImprovement
getTitle() - Method in Improvement: Title of the improvement.
getUpdateNotableVersions() - Method in BumpVersionFileTask: Whether to update notable versions by adding previous version to list
getUpdateNotableVersions() - Method in DefaultBumpVersionFileTask
getUrl() - Method in DefaultImprovement
getUrl() - Method in Improvement: The link to the improvement.
getVcsCommitsLinkTemplate() - Method in NotesGeneration
getVcsTag() - Method in DefaultReleaseNotesData
getVcsTag() - Method in ReleaseNotesData: The vcs addressable tag of this version
getVersion() - Method in DefaultReleaseNotesData
getVersion() - Method in ReleasedVersion: Version number
getVersion() - Method in ReleaseNotesData: Version of the released software component
getVersion() - Method in VersionFile: Version number
getVersionFile() - Method in BumpVersionFileTask: File that contains version number information, for example: "version=0.0.1"
getVersionFile() - Method in DefaultBumpVersionFileTask
Git - Class in org.mockito.release.git: Git utilities
GitAuthor - Interface in org.mockito.release.git: Operations related to git author
GitHubCommitsJSON - Class in org.mockito.release.notes.contributors: Provides means to parse JsonObjects returned from calling GitHub API.
GitHubContributorsFetcher - Class in org.mockito.release.notes.contributors
GitHubContributorsProvider - Class in org.mockito.release.notes.contributors
GitHubFetcher - Class in org.mockito.release.notes.util: This class contains standard operations for skim over GitHub API responses.
GitHubFetcher(String) - Constructor in GitHubFetcher
gitHubNotesBuilder(File, String, String) - Method in Notes: Release notes build based on git and GitHub.
GitRevisionProvider - Class in org.mockito.release.notes.vcs
GitRevisionProvider(ProcessRunner) - Constructor in GitRevisionProvider
GitTool - Interface in org.mockito.release.git: Git operations
gitTool(ProcessRunner) - Method in Git: Provides git tool that uses given process runner
GradleDSLHelper - Class in org.mockito.release.internal.gradle.util: Useful to work around Gradle API that requires the use of Groovy.
graphPopulated(TaskExecutionGraph) - Method in LazyConfigurer

H

hasNextPage() - Method in GitHubFetcher

I

Improvement - Interface in org.mockito.release.notes.model: Improvement tracked by given issue/bug tracker.
Improvements - Class in org.mockito.release.notes.improvements: Improvements based on some issue tracking system outside of the vcs.
ImprovementsProvider - Interface in org.mockito.release.notes.improvements: Provides tracked improvements to be referenced in release notes
init() - Method in GitHubFetcher
IOUtil - Class in org.mockito.release.notes.util: IO utils.
isOnlyPullRequests() - Method in NotesGeneration
isPublicationsEqual() - Method in PublicationsComparator: Gives information if publications are equal
isPublicationsEqual() - Method in PublicationsComparatorTask
isPullRequest() - Method in DefaultImprovement
isPullRequest() - Method in Improvement: Informs if given issue is a pull request
isReleaseDryRun() - Method in ExtContainer: If the release should be a dry run and avoid publishing to Bintray, GitHub, etc.
isTrue(T) - Method in Predicate: returns true if the predicate is satisfied for given object

J

JavaLibraryPlugin - Interface in org.mockito.release.gradle: Intended to be applied in individual Java submodule.
join(Collection<String>, String) - Method in StringUtil: Classic string join

K

keySet() - Method in MultiMap

L

LazyConfigurer - Class in org.mockito.release.internal.gradle.util: Offers means to lazily configure Gradle tasks, only when the tasks are in the task graph.

M

mapContributorsToGitHubUser(ContributionSet, String, String) - Method in ContributorsProvider
mapContributorsToGitHubUser(ContributionSet, String, String) - Method in GitHubContributorsProvider
MultiMap - Class in org.mockito.release.util: Basic multi-map that contains multiple values per key
MultiReleaseNotesFormatter - Interface in org.mockito.release.notes.format: Formats release notes across multiple releases

N

nextPage() - Method in GitHubFetcher
notableFormatter(String, String, String) - Method in ReleaseNotesFormatters: Returns the concise formatter intended to use for notable releases
NotableReleaseNotesFetcherTask - Class in org.mockito.release.internal.gradle
NotableReleaseNotesGeneratorTask - Class in org.mockito.release.internal.gradle
Notes - Class in org.mockito.release.notes: Release notes services
NotesBuilder - Interface in org.mockito.release.notes: Builds the release notes text
NotesGeneration - Class in org.mockito.release.internal.gradle
notNull(Object) - Method in ArgumentValidation: None of the input targets can not be null otherwise IllegalArgumentException is thrown.

O

onlyIf(Callable<Boolean>) - Method in ReleaseWorkflow: Adds a predicate check that can cleanly abort the release process
onlyIf(Callable<Boolean>) - Method in ReleaseWorkflowExtension

P

parseDate(String) - Method in DateFormat: Parses date in iso format, e.g.
parseDateInEpochSeconds(String) - Method in DateFormat: Parse Date in epoch seconds (Unix time).
parseUTCDate(String) - Method in DateFormat: Parses date in simple format, UTC, e.g.
PomCustomizer - Class in org.mockito.release.internal.gradle.util
Predicate - Interface in org.mockito.release.notes.util: Generic predicate
previousFromNotesContent(String) - Method in Versions: Provides a way to retrieve previous version based on the content of the release notes file.
PreviousVersion - Interface in org.mockito.release.notes.versions: Provides the previous version.
previousVersion(String) - Method in Notes: Provides previous version information based on the release notes content file
ProcessRunner - Interface in org.mockito.release.exec: Provides ways to execute external processes
publications(Project, Action<PublicationContainer>) - Method in GradleDSLHelper: Needed because we cannot access publications or publishing normally via Java Doing so will "resolve" the publications too early and things would not work For example, pom would not have dependencies
PublicationsComparator - Interface in org.mockito.release.comparison: Compares publications
PublicationsComparatorTask - Class in org.mockito.release.comparison
put(K, V) - Method in MultiMap

Q

R

readFully(InputStream) - Method in IOUtil: Reads string from the stream and closes it
ReleasedVersion - Interface in org.mockito.release.notes.vcs: Contains information about released version
ReleasedVersionsProvider - Interface in org.mockito.release.notes.vcs: Provides release dates for versions
ReleaseNotesData - Interface in org.mockito.release.notes.model: Contains all the information that is needed for release notes for single specific release (version).
ReleaseNotesException - Class in org.mockito.release.notes.util
ReleaseNotesException(String, Throwable) - Constructor in ReleaseNotesException
ReleaseNotesExtension - Interface in org.mockito.release.gradle: TODO: kill this API, figure out what to do with 'getPreviousVersion'
ReleaseNotesFormatters - Class in org.mockito.release.notes.format: Gives access to all release and version notes formatters
ReleaseNotesGenerator - Interface in org.mockito.release.notes.generator: Generates release notes data model.
releaseNotesGenerator(File, String, String) - Method in ReleaseNotesGenerators
ReleaseNotesGenerators - Class in org.mockito.release.notes.generator
ReleaseNotesPlugin - Interface in org.mockito.release.gradle: The plugin adds following tasks:
ReleaseNotesSerializer - Class in org.mockito.release.internal.gradle.util
ReleaseNotesSerializer(File) - Constructor in ReleaseNotesSerializer
ReleaseToolsProperties - Enum in org.mockito.release.gradle: Properties required by release tools plugins.
ReleaseWorkflow - Interface in org.mockito.workflow.gradle: Enables configuring release workflow steps.
ReleaseWorkflowExtension - Class in org.mockito.workflow.gradle.internal
ReleaseWorkflowExtension(Project) - Constructor in ReleaseWorkflowExtension
ReleaseWorkflowPlugin - Class in org.mockito.workflow.gradle.internal
restoreOriginal() - Method in GitAuthor: Restores the local author / email to the original values
RevisionProvider - Interface in org.mockito.release.notes.vcs: Provides revision numbers for changes
run(String) - Method in ProcessRunner: Executes given command line and returns the output.

S

serialize(Collection<ReleaseNotesData>) - Method in ReleaseNotesSerializer
setAuthor(String, String) - Method in GitTool: Configures local git author by name and email.
setDetailedReleaseNotesLink(String) - Method in NotesGeneration
setGitHubLabelMapping(Map<String, String>) - Method in DefaultReleaseNotesExtension
setGitHubLabels(Collection<String>) - Method in NotesGeneration
setGitHubReadOnlyAuthToken(String) - Method in DefaultReleaseNotesExtension
setGitHubReadOnlyAuthToken(String) - Method in NotesGeneration
setGitHubRepository(String) - Method in DefaultReleaseNotesExtension
setGitHubRepository(String) - Method in NotesGeneration
setGitWorkingDir(File) - Method in NotesGeneration
setHeadVersion(String) - Method in NotesGeneration
setIntroductionText(String) - Method in NotesGeneration
setOnlyPullRequests(boolean) - Method in NotesGeneration
setOutputFile(File) - Method in NotesGeneration
setReleaseNotesFile(File) - Method in DefaultReleaseNotesExtension
setTagPrefix(String) - Method in NotesGeneration
setTargetVersions(Collection<String>) - Method in NotesGeneration
setTemporarySerializedNotesFile(File) - Method in NotesGeneration
setUpdateNotableVersions(boolean) - Method in BumpVersionFileTask: See getUpdateNotableVersions()
setUpdateNotableVersions(boolean) - Method in DefaultBumpVersionFileTask
setVcsCommitsLinkTemplate(String) - Method in NotesGeneration
setVersionFile(File) - Method in BumpVersionFileTask: See getVersionFile()
setVersionFile(File) - Method in DefaultBumpVersionFileTask
SingleReleaseNotesFormatter - Interface in org.mockito.release.notes.format: Formats version notes
size() - Method in ContributorsSet
size() - Method in MultiMap
step(Task) - Method in ReleaseWorkflow: Adds task to release workflow, without any special configuration (rollback or cleanup)
step(Task) - Method in ReleaseWorkflowExtension
StringUtil - Class in org.mockito.release.internal.gradle.util: String utilities.

T

TabularFormatter - Class in org.mockito.release.notes.format: Tabular formatter
task(Project, String, Action<Task>) - Method in CommonSettings: Creates task with preconfigured defaults
TASK_GROUP - Field in CommonSettings
TEMP_SERIALIZED_NOTES_FILE - Field in DefaultReleaseNotesPlugin

U

updateReleaseNotes(String) - Method in DefaultReleaseNotesExtension
updateReleaseNotes(String) - Method in ReleaseNotesExtension: Generates incremental release notes content using getReleaseNotes(String) )} and appends it to the top of release notes file.

V

Vcs - Class in org.mockito.release.notes.vcs: Vcs services
Version - Class in org.mockito.release.version: Version utilities
VersionFile - Interface in org.mockito.release.version: The file that contains version number TODO rename to VersionInfo
versionFile(File) - Method in Version: Provides instance of version file
VersioningPlugin - Interface in org.mockito.release.gradle: The plugin adds following tasks:
Versions - Class in org.mockito.release.notes.versions: Version services