Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump maven-jellydoc-plugin from 1.9 to 1.10 #30

Merged
merged 2 commits into from
Jan 3, 2023
Merged

Bump maven-jellydoc-plugin from 1.9 to 1.10 #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db194eb
Bump maven-jellydoc-plugin from 1.9 to 1.10
dependabot[bot] Jan 3, 2023
8f76613
Use non-deprecated `Sink` class
basil Jan 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
<changelist>-SNAPSHOT</changelist>
<gitHubRepo>jenkinsci/${project.artifactId}</gitHubRepo>
<maven.version>3.8.7</maven.version>
<plexus.version>2.1.1</plexus.version>
<maven-plugin-tools.version>3.7.0</maven-plugin-tools.version>
<!-- TODO fix violations -->
<spotbugs.threshold>High</spotbugs.threshold>
Expand Down Expand Up @@ -116,7 +117,12 @@
<dependency>
<groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-component-annotations</artifactId>
<version>2.1.1</version>
<version>${plexus.version}</version>
</dependency>
<dependency>
<groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-container-default</artifactId>
<version>${plexus.version}</version>
</dependency>
<dependency>
<groupId>org.codehaus.plexus</groupId>
Expand Down Expand Up @@ -156,7 +162,7 @@
<dependency>
<groupId>org.jvnet.maven-jellydoc-plugin</groupId>
<artifactId>maven-jellydoc-plugin</artifactId>
<version>1.9</version>
<version>1.10</version>
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
Expand Down
46 changes: 41 additions & 5 deletions src/main/java/org/kohsuke/stapler/TaglibDocMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@
import com.sun.xml.txw2.output.StreamSerializer;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.factory.ArtifactFactory;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.SinkFactory;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.model.Resource;
import org.apache.maven.plugin.AbstractMojo;
Expand All @@ -38,10 +40,9 @@
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.project.MavenProject;
import org.apache.maven.project.MavenProjectHelper;
import org.apache.maven.reporting.MavenReport;
import org.apache.maven.reporting.MavenMultiPageReport;
import org.apache.maven.reporting.MavenReportException;
import org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver;
import org.codehaus.doxia.sink.Sink;
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.DocumentFactory;
Expand Down Expand Up @@ -79,7 +80,7 @@
*/
@Mojo(name = "jelly-taglibdoc", requiresDependencyResolution = ResolutionScope.COMPILE)
@Execute(phase = LifecyclePhase.GENERATE_SOURCES)
public class TaglibDocMojo extends AbstractMojo implements MavenReport {
public class TaglibDocMojo extends AbstractMojo implements MavenMultiPageReport {
/**
* The Maven Project Object
*/
Expand Down Expand Up @@ -256,11 +257,46 @@ private void parseTagFile(File tagFile, Tag tag) throws IOException {
}

//
// MavenReport implementation
// MavenMultiPageReport implementation
//
/**
* Generate a report.
*
* @param sink The sink to use for the generation.
* @param locale The desired locale in which to generate the report; could be null.
* @throws MavenReportException if any error occurs
* @deprecated use {@link #generate(Sink, SinkFactory, Locale)} instead.
*/
@Deprecated
@Override
public void generate(org.codehaus.doxia.sink.Sink sink, Locale locale) throws MavenReportException {
getJellydocMojo().generate(sink, locale);
}

/**
* Generate a report.
*
* @param sink The sink to use for the generation.
* @param locale The desired locale in which to generate the report; could be null.
* @throws MavenReportException if any error occurs
* @deprecated use {@link #generate(Sink, SinkFactory, Locale)} instead.
*/
@Deprecated
public void generate(Sink sink, Locale locale) throws MavenReportException {
getJellydocMojo().generate(sink,locale);
getJellydocMojo().generate(sink, locale);
}

/**
* This method is called when the report generation is invoked by maven-site-plugin.
*
* @param sink The sink to use for the generation.
* @param sinkFactory The sink factory to use for the generation; could be null.
* @param locale The desired locale in which to generate the report; could be null.
* @throws MavenReportException if any error occurs
*/
@Override
public void generate(Sink sink, SinkFactory sinkFactory, Locale locale) throws MavenReportException {
getJellydocMojo().generate(sink, sinkFactory, locale);
}

@Override
Expand Down