Mojo Latex Maven Plugin

Add a configuration parameter that allow the generation to be skipped

Details

  • Type: Improvement Improvement
  • Status: Open Open
  • Priority: Minor Minor
  • Resolution: Unresolved
  • Affects Version/s: 1.1, 1.2
  • Fix Version/s: None
  • Labels:
    None
  • Number of attachments :
    0

Description

The idea is to add a simple parameter that is checked and skipped the generation.
This is useful when the plugin is used in large project and when it is not required to generate the documents/manuals under certain circumstance, such as testing, or if the latex runtime is not available in some environment by default.

+ /**
+ * Indicates whether or not the latex generation should be skipped.
+ *
+ * @parameter expression="$

{latex.skip}

" default-value="false"
+ */
+ private boolean skipGeneration;

public void execute()
throws MojoExecutionException, MojoFailureException
{
+ if ( skipGeneration )
+

{ + getLog().info( "Latex generation skipped." ); + return; + }

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Arnauld Loyer added a comment -

Actually my workaround is to trigger the generation in an unknown maven phase.

Show
Arnauld Loyer added a comment - Actually my workaround is to trigger the generation in an unknown maven phase.
Hide
Permalink
Michael added a comment -

I don't see the point here.

If you don't want to compile it, comment it out?!

Show
Michael added a comment - I don't see the point here. If you don't want to compile it, comment it out?!
Hide
Permalink
Ian Robertson added a comment -

I frequently use the skip parameter for modules which support it. I might be trying to debug a particular build issue, and want my build to run quickly. While commenting out a pom is one option, providing a -Dlatex.skip=true on the command line can be much faster.

Notably, for plugins configured in parent poms that come from a repository, commenting out the plugin may not event be an option.

Show
Ian Robertson added a comment - I frequently use the skip parameter for modules which support it. I might be trying to debug a particular build issue, and want my build to run quickly. While commenting out a pom is one option, providing a -Dlatex.skip=true on the command line can be much faster. Notably, for plugins configured in parent poms that come from a repository, commenting out the plugin may not event be an option.
Hide
Permalink
Peter Reutemann added a comment -

I second Ian. Quite often I need to test large multi-module projects (ie compile, package, run) that have large LaTeX manuals with lots of screenshots. Having a command-line flag for turning off the PDF generation would cut down the time it takes packaging the project. Just like with the -DskipTests=true flag for junit tests.

Show
Peter Reutemann added a comment - I second Ian. Quite often I need to test large multi-module projects (ie compile, package, run) that have large LaTeX manuals with lots of screenshots. Having a command-line flag for turning off the PDF generation would cut down the time it takes packaging the project. Just like with the -DskipTests=true flag for junit tests.
Hide
Permalink
Michael added a comment -

Ok, now I understand.
I did not know about that command line feature of maven
I'm a maven-IDE-only-user.

Show
Michael added a comment - Ok, now I understand. I did not know about that command line feature of maven I'm a maven-IDE-only-user.
Hide
Permalink
Nick Cross added a comment -

I third this This would match the skip functionality in other plugins e.g. https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#skip
This would also avoid having to insert this plugin into a profile for conditional activation.

Show
Nick Cross added a comment - I third this This would match the skip functionality in other plugins e.g. https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#skip This would also avoid having to insert this plugin into a profile for conditional activation.
Hide
Permalink
Yegor Bugayenko added a comment -

I also vote for this feature

Show
Yegor Bugayenko added a comment - I also vote for this feature

People

  • Assignee:
    Unassigned
    Reporter:
    Arnauld Loyer
Vote (3)
Watch (5)

Dates

  • Created:
    Updated: