Asciidoctor :: Discussion

Maven plugin skip

_‹ Previous Topic Next Topic _›

Classic

List

Threaded

22 messages Options

julien

May 07, 2015; 12:42pm

Maven plugin skip

18 posts

Hi,

is it planned to have a skip property in the maven plugin ?

cheers

Julien

abelsromero

May 07, 2015; 4:09pm

Re: Maven plugin skip

242 posts

Hi Julien,

It may be a silly question, but can you elaboratea bit more about what do you mean by "skip"?

Thanks :)

julien

May 07, 2015; 7:58pm

Re: Maven plugin skip

18 posts

I mean a property when set to anything it skips the execution of the asciidoctor task.

The use case is to have something like

<configuration>
<skip>${skipDocs}</skip>
</configuration>

So one can run a build with : mvn -DskipDocs

to skip the doc generation, like -DskipTests exists

Many artifacts do have such property, surefire-plugin, clean-plugin, etc...

mojavelinux

May 07, 2015; 8:03pm

Re: Maven plugin skip

Administrator

2681 posts

I'm in support of the idea, mostly because it follows conventions set by other plugins. Having said that, this can also be accomplished using profiles, which is how other projects are doing it today.

-Dan

julien

May 07, 2015; 8:07pm

Re: Maven plugin skip

18 posts

it is similar but different than profiles, here is a use case (that I need actually and cannot be resolved by profiles):

A parent pom defines an asciidoctor plugin execution and make it skippable with a property (skipDocs). A pom inherits from the parent, this pom does not want to have doc generation for some reason, it can set skipDocs in its property declaration and it works.

With profiles that is not possible because profile activation is evaluated before properties are evaluated. We do have this use case (problem) at the moment for Vert.x 3 build.

abelsromero

May 07, 2015; 8:54pm

Re: Maven plugin skip

242 posts

Can't argue with that case.
Regarding the request, it's not a weird feature and it can surely help on multi-modules build, i vote for it.
What name should we use?

julien

May 19, 2015; 3:21pm

Re: Maven plugin skip

18 posts

In reply to this post by mojavelinux

here is a PR for this small feature : https://github.com/asciidoctor/asciidoctor-maven-plugin/pull/162

julien

Jun 03, 2015; 1:24pm

Re: Maven plugin skip

18 posts

I would like to know when the maven plugin can be released with this feature, it would be convenient to change our Vert.x builds to use it and remove the current workaround we have.

thanks.

mojavelinux

Jun 03, 2015; 10:35pm

Re: Maven plugin skip

Administrator

2681 posts

Abel,

I think we can go ahead and do a 1.5.2.1 release based on Asciidoctor 1.5.2. wdyt?

-Dan

On Wed, Jun 3, 2015 at 7:24 AM, julien [via Asciidoctor :: Discussion] <[hidden email]> wrote:

I would like to know when the maven plugin can be released with this feature, it would be convenient to change our Vert.x builds to use it and remove the current workaround we have.

thanks.

If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Maven-plugin-skip-tp3135p3301.html

To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML

Dan Allen | http://google.com/profiles/dan.j.allen

julien

Jun 06, 2015; 8:34am

Re: Maven plugin skip

18 posts

I would be nice to release it, however if you do it, we would appreciate a release soon because otherwise it would be too late for us to change after that.

mojavelinux

Jun 06, 2015; 9:08pm

Re: Maven plugin skip

Administrator

2681 posts

Let's plan to do a 1.5.2.1 release this week. Abel, are you available this week for some release festivities?

-Dan

On Sat, Jun 6, 2015 at 2:34 AM, julien [via Asciidoctor :: Discussion] <[hidden email]> wrote:

I would be nice to release it, however if you do it, we would appreciate a release soon because otherwise it would be too late for us to change after that.

If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Maven-plugin-skip-tp3135p3321.html

To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML

Dan Allen | http://google.com/profiles/dan.j.allen

abelsromero

Jun 07, 2015; 3:57pm

Re: Maven plugin skip

242 posts

Sure! If Tuesday night is OK, it can be done.

julien

Jun 07, 2015; 3:58pm

Re: Maven plugin skip

18 posts

it's ok

mojavelinux

Jun 07, 2015; 7:08pm

Re: Maven plugin skip

Administrator

2681 posts

Super! I'll be around to help if you need me.

-Dan

On Sun, Jun 7, 2015 at 9:58 AM, julien [via Asciidoctor :: Discussion] <[hidden email]> wrote:

it's ok

If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Maven-plugin-skip-tp3135p3328.html

To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML

Dan Allen | http://google.com/profiles/dan.j.allen

julien

Jun 10, 2015; 8:48am

Re: Maven plugin skip

18 posts

In reply to this post by abelsromero

any news about this ? it becomes urgent.

abelsromero

Jun 10, 2015; 9:31am

Re: Maven plugin skip

242 posts

The release was done yesterday eve but it's stuck in the final step, between bintray and maven repo because I lack some permissions.
We've already requested them, as soon as I'll get them it will pubished.

Sorry for the inconvenience caused. We're using this deploy to validate and document the whole process so that I or another person in the future can deploy future release. If it's urgent, Dan can just finish it.

mojavelinux

Jun 10, 2015; 10:43am

Re: Maven plugin skip

Administrator

2681 posts

I'll go ahead and push this one because I really have no way of knowing how long we are going to wait on Sontatype. It should appear within minutes after I click the button.

...button clicked :)

Thanks again, Abel, for making the release!

Cheers,

-Dan

On Wed, Jun 10, 2015 at 3:31 AM, abelsromero [via Asciidoctor :: Discussion] <[hidden email]> wrote:

The release was done yesterday eve but it's stuck in the final step, between bintray and maven repo because I lack some permissions.
We've already requested them, as soon as I'll get them it will pubished.

Sorry for the inconvenience caused. We're using this deploy to validate and document the whole process so that I or another person in the future can deploy future release. If it's urgent, Dan can just finish it.

If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Maven-plugin-skip-tp3135p3344.html

To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML

Dan Allen | http://google.com/profiles/dan.j.allen

abelsromero

Jun 10, 2015; 12:26pm

Re: Maven plugin skip

242 posts

Mission accomplished! v 1.5.2.1 it's already available for download from maven central.
A shame I could not complete it, but at least, this time I wrote down all steps to add it to the wiki.

@julien, let us know if you have any problem with the version.

mojavelinux

Jun 10, 2015; 9:28pm

Re: Maven plugin skip

Administrator

2681 posts

Abel,

> Mission accomplished! v 1.5.2.1 it's already available for download from maven central.

\o/

> at least, this time I wrote down all steps to add it to the wiki.

Thank you. That's super valuable!!

As it turns out, the admin from Sonatype got back to us pretty quickly, so now you have permissions to sync. You'll be all set to take the next release all the way.

Cheers,

-Dan

On Wed, Jun 10, 2015 at 6:26 AM, abelsromero [via Asciidoctor :: Discussion] <[hidden email]> wrote:

Mission accomplished! v 1.5.2.1 it's already available for download from maven central.
A shame I could not complete it, but at least, this time I wrote down all steps to add it to the wiki.

@julien, let us know if you have any problem with the version.

If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Maven-plugin-skip-tp3135p3350.html

To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML

Dan Allen | http://google.com/profiles/dan.j.allen

julien

Jun 10, 2015; 9:29pm

Re: Maven plugin skip

18 posts

thanks all, I will try soon and let you know if there are any issues.