Skip to content
This repository has been archived by the owner on Jan 18, 2021. It is now read-only.

Release notes contain link to new Javadoc #799

Open
mstachniuk opened this issue Mar 17, 2019 · 0 comments
Open

Release notes contain link to new Javadoc #799

mstachniuk opened this issue Mar 17, 2019 · 0 comments
Labels
feature:javadoc-plugin feature:release-notes good first issue Please contribute! It's a good first issue to start. size:M

Comments

@mstachniuk
Copy link
Contributor

When "org.shipkit.javadoc" plugin is applied, then release notes should contain a link (as a badge) to the published Javadoc.

By default, the link should point to the specified directory ("javadoc.repositoryDirectory") and branch "javadoc.repositoryBranch" (see ShipkitConfiguration.java for more configuration options).

There should be also a possibility to point to some class, e.g. for Mockito project link can point to the "org.mockito.Mockito" class. This should be configurable.

Starting point:

// TODO release notes contain link to new javadoc
String notes = ReleaseNotesFormatters.detailedFormatter(headerMessage,
"", task.getGitHubLabelMapping(), vcsCommitTemplate, task.getPublicationRepository(),
contributorsMap, task.isEmphasizeVersion(), badgeFormatter)
.formatReleaseNotes(data);

@mstachniuk mstachniuk added size:M feature:release-notes good first issue Please contribute! It's a good first issue to start. feature:javadoc-plugin labels Mar 17, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
feature:javadoc-plugin feature:release-notes good first issue Please contribute! It's a good first issue to start. size:M
Projects
None yet
Development

No branches or pull requests

1 participant