Jean-Christophe Gay

Use a unique property to set Maven version

Fri, 02 Sep 2016 20:49:00 +0200

When working with a Maven multi-module (dozens of them) project on multiple branches, I always end up with merge conflicts on my pom.xml <version> elements.
Here is a solution I use to remove all the <version> element duplication.

Our example project is made of two modules:

.
├── pom.xml
├── submodule-1
│   └── pom.xml
└── submodule-2
    └── pom.xml

Parent project pom.xml looks like:

<project>
 <groupId>com.github.jcgay.example.version</groupId>
 <artifactId>parent-pom</artifactId>
 <version>1.0-SNAPSHOT</version>
 <packaging>pom</packaging>

 <modules>
 <module>submodule-1</module>
 <module>submodule-2</module>
 </modules>
 
</project>

and the ones for modules:

<project>
 <parent>
 <groupId>com.github.jcgay.example.version</groupId>
 <artifactId>parent-pom</artifactId>
 <version>1.0-SNAPSHOT</version>
 </parent>

 <artifactId>submodule-1</artifactId>

</project>

Project version is duplicated in each module’s pom.xml, it’s easy to change them with the Versions plugin. But merges between branches are a pain, conflicts are happening and we just can’t keep the changes from one of the branch 😓.

Define the version with a property
#

First try, extract the version is a Maven property. Our parent pom becomes:

<project>
 <groupId>com.github.jcgay.example.version</groupId>
 <artifactId>parent-pom</artifactId>
 <version>${my-version}</version>
 <packaging>pom</packaging>

 <properties>
 <my-version>1.0-SNAPSHOT</my-version>
 </properties>

 <modules>
 <module>submodule-1</module>
 <module>submodule-2</module>
 </modules>

</project>

and the module use the same ${my-version} property to designate its parent:

<project>
 <parent>
 <groupId>com.github.jcgay.example.version</groupId>
 <artifactId>parent-pom</artifactId>
 <version>${my-version}</version>
 </parent>

 <artifactId>submodule-2</artifactId>

</project>

Surprisingly it works 😲
Only downside is that warning messages are displayed by Maven.

Some problems were encountered while building the effective model for com.github.jcgay.example.version:submodule-1:jar:1.0-SNAPSHOT
'version' contains an expression but should be a constant. @ com.github.jcgay.example.version:parent-pom:${my-version}, /Users/jcgay/dev/toolbox-examples/unique-maven-version/pom.xml, line 7, column 14

Some problems were encountered while building the effective model for com.github.jcgay.example.version:submodule-2:jar:1.0-SNAPSHOT
'version' contains an expression but should be a constant. @ com.github.jcgay.example.version:parent-pom:${my-version}, /Users/jcgay/dev/toolbox-examples/unique-maven-version/pom.xml, line 7, column 14

Some problems were encountered while building the effective model for com.github.jcgay.example.version:parent-pom:pom:1.0-SNAPSHOT
'version' contains an expression but should be a constant. @ com.github.jcgay.example.version:parent-pom:${my-version}, /Users/jcgay/dev/toolbox-examples/unique-maven-version/pom.xml, line 7, column 14

It is highly recommended to fix these problems because they threaten the stability of your build.

For this reason, future Maven versions might no longer support building such malformed projects.

So we can’t just really use that, and there is also a much bigger problem but we will discover it later.

Continuous delivery friendly version
#

Since Maven 3.2.1 we can use registered properties to hide the previous warning messages.

Replacing the property my-version by revision will do the trick 🎆.

But the real problem is showing now… When Maven install (or deploy) ours artifacts, pom.xml are copied without modification (${revision} properties are not replaced by their resolved value). If you try to depend on one of these artifacts it will fail because ${revision} will not be set in this outside project.

Example with this simple project which is not built within parent-pom reactor:

<project>
 <groupId>com.github.jcgay.example.version</groupId>
 <artifactId>independant-project</artifactId>
 <version>1.0-SNAPSHOT</version>
 
 <dependencies>
 <dependency>
 <groupId>com.github.jcgay.example.version</groupId>
 <artifactId>submodule-1</artifactId>
 <version>1.0-SNAPSHOT</version>
 </dependency>
 </dependencies>

</project>

When we launch a build:

$> mvn test

Scanning for projects...

Using the MultiThreadedBuilder implementation with a thread count of 4

------------------------------------------------------------------------
Building independant-project 1.0-SNAPSHOT
------------------------------------------------------------------------
Downloading: https://repo.maven.apache.org/maven2/com/github/jcgay/example/version/parent-pom/$%7Brevision%7D/parent-pom-$%7Brevision%7D.pom
------------------------------------------------------------------------
BUILD FAILURE
------------------------------------------------------------------------
Total time: 0.882 s (Wall Clock)
Finished at: 2016-08-09T15:26:09+02:00
Final Memory: 12M/193M
------------------------------------------------------------------------
Failed to execute goal on project independant-project: Could not resolve dependencies for project com.github.jcgay.example.version:independant-project:jar:1.0-SNAPSHOT: Failed to collect dependencies at com.github.jcgay.example.version:submodule-1:jar:1.0-SNAPSHOT: Failed to read artifact descriptor for com.github.jcgay.example.version:submodule-1:jar:1.0-SNAPSHOT: Could not find artifact com.github.jcgay.example.version:parent-pom:pom:${revision} in central (https://repo.maven.apache.org/maven2) -> [Help 1]

In fact the pom.xml available in the local repository still defines ${revision} as a <version> for the pom-parent.

Filtering pom at installation/deployment
#

These non filtered properties remind me an old blog post. The author was filtering (with maven-resources-plugin) its pom.xml to install them instead of the originals. I was wondering if this could be achieved by a Maven extension (the amount of necessary XML and the hacky feeling of the solution just discourage me…). This is doable with Aether (used by Maven 3) by implementing a org.eclipse.aether.impl.MetadataGenerator. We can code our hack 🤔.

Code is available at GitHub. This a Maven extension which will transform pom artifacts when installing and deploying. Each ${revision} occurrence is replaced by the artifact’s resolved version. Problem solved!

Activate it using the core extensions configuration mechanism by creating a ${maven.multiModuleProjectDirectory}/.mvn/extensions.xml file with:

<?xml version="1.0" encoding="UTF-8"?>
<extensions>
 <extension>
 <groupId>fr.jcgay.maven.extension</groupId>
 <artifactId>unique-revision-maven-filtering</artifactId>
 <version>[latest-version]</version>
 </extension>
</extensions>

or by copying jar to %M2_HOME%/lib/ext.

Conclusion
#

We can now use a unique property to set version across all modules in a multi-modules project. This does not seems to play by the rules of the continuous delivery friendly version but merges can now be done without resolving multiple conflicts on <version> XML elements!
I may have totally missed a simpler way to do this ? (in that case I’d really like to know it 😉).

Deploy Maven SNAPSHOT with Travis CI

Wed, 29 Jul 2015 21:23:00 +0200

Guide to deploy SNAPSHOT binaries on OSS sonatype repository with Travis CI.

Maven configuration
#

Maven must be setup to use your personal account to access sonatype repository. Create a etc/deploy-settings.xml file and use variables to set username and password:

<settings>
 <servers>
 <server>
 <id>ossrh</id>
 <username>${env.OSSRH_USER}</username>
 <password>${env.OSSRH_PASS}</password>
 </server>
 </servers>
</settings>

This file will be passed to mvn with the option --settings.

Identification
#

We have two solutions to store ours username and password for Travis CI.

Repository settings
#

In Travis CI repository settings https://travis-ci.org/user/repository/settings, we can define environment variables OSSRH_USER and OSSRH_PASS. They will be hidden in logs by default.

Encrypt username and password
#

Obviously we don’t want to store our sensible data in clear text, Travis CI allow us to encrypt data.

gem install travis

And here comes Ruby… if you’re not a ruby developper, things can go wrong from here (at least with OS X).
In my case I faced the error:

> gem install travis 
Fetching: multipart-post-2.0.0.gem (100%)
ERROR: While executing gem ... (Gem::FilePermissionError)
 You don't have write permissions for the /Library/Ruby/Gems/2.0.0 directory.

The problem comes from the bundled version installed by Apple, Ruby users are certainly using rvm, rbenv or some other tool. But for others who don’t want to waste time trying to figure out the Ruby ecosystem, just:

brew install ruby

Relaunch a shell and travis gem installation should succeed…

We can finally ask travis to encrypt our username and password:

travis encrypt --add -r jcgay/send-notification "OSSRH_USER='toto'"
travis encrypt --add -r jcgay/send-notification "OSSRH_PASS='s3cret&'"

If commands are executed from the project folder, option -r is not necessary and you can use --add to automatically write encrypted keys in .travis.yml. jcgay/send-notification is the project you want to encrypt keys for.

Configuration de Travis CI
#

We don’t want to deploy SNAPSHOT when Travis is building a pull-request. We can read ${TRAVIS_PULL_REQUEST} variable to skip deployment when its value equals false. Same goes when Travis is building a release, as they are made outside Travis in my case, I don’t want a deployment when ${TRAVIS_TAG} variable is not empty.

So our .travis.yml contains:

env:
 global:
 - secure: GT8Hi5kgx2cLAGzh2ggZNTgiLm8J5fd64SYG3bkhgwZGbV/HRD8r8a1SYv1iQ72JqrDhlHQ7q8h17nDBFLjy99h/XKN4MacBu9CZhnPO7lXpuRefD3W/db6zWSk17a5DAKAt+1UOeyfohEkzx+JHcTfbvMg6hy+3DEPaVMUtV04=
 - secure: fQ4bSOcHWEURfsDQVhWA152GCiezQfh9YC45a2zae8oOk+6bIrHmrkJSyVYpUCLGdqO3Df+JTy6bfoqyJEsX7PkzGPZ10odSHw5qDqfTIolt7UympKtUvUNi6h5G6virGhBWjjs5REGjrgWdTlqKjNT2Ax/VlzNRskqaVAhEhl0=

and one more step as after_success:

after_success:
 - "[[ ${TRAVIS_PULL_REQUEST} == 'false' ]] && [[ ${TRAVIS_TAG} == '' ]] && mvn deploy -DskipTests --settings etc/deploy-settings.xml"

Enjoy fresh deployed SNAPSHOT !

Desktop notifications for Gradle

Wed, 13 May 2015 17:35:00 +0200

When building projects, time can pass slowly… Most of the time they run as background tasks and I like to have a notification when they have finished.
There is a built-in plugin for Gradle to send notifications but we’ll see how to get more possible notifiers !

Gradle Build Announcements
#

This is the built-in plugin distributed with Gradle. It relies on Announce plugin, which allow sending custom notifications during a build.
It comes with four possible implementations:

twitter
notify-send
Snarl
Growl

It is easy to activate, just add in your build.gradle:

apply plugin: 'build-announcements'

or use it in $HOME/.gradle/init.gradle to have the plugin running by default for all your Gradle projects:

rootProject {
 apply plugin: 'build-announcements'
}

It is really nice to have this functionality available without extra installation… But there is not so much tools available and sent notifications lack of visual distinction (icon is always the same whatever the build result).

Gradle notifier
#

As I already have written my own notifications for Maven with maven-notifier, I have just migrated them to run with Gradle in gradle-notifier!

It comes with support for:

Notifier	Screenshot
Growl, for Windows and OS X.
Snarl, for Windows
terminal-notifier, OS X
notification center OS X (since Mavericks)
notify-send for Linux
SystemTray since Java 6
Pushbullet
Kdialog for KDE
notifu for Windows
AnyBar for OS X and Linux
Toaster for Windows 8
Notify since Java 6
BurntToast for Windows 10
Slack

Installation
#

Plugin can be configured in an initialization script or directly in a build script.

Initialization script
#

Create (or edit) file $HOME/.gradle/init.gradle:

initscript {
 repositories {
 mavenCentral()
 }

 dependencies {
 classpath group: 'fr.jcgay', name: 'gradle-notifier', version: '1.1.0'
 }
}

rootProject {
 apply plugin: fr.jcgay.gradle.notifier.GradleNotifierPlugin
}

Build script
#

In your build.gradle, add:

buildscript {
 repositories {
 mavenCentral()
 }

 dependencies {
 classpath group: 'fr.jcgay', name: 'gradle-notifier', version: '1.1.0'
 }
}

apply plugin: 'fr.jcgay.gradle-notifier'

or by using the plugin mechanism introduced in Gradle 2.1:

plugins {
 id "fr.jcgay.gradle-notifier" version "1.1.0"
}

Configuration
#

It relies on send-notification, notifiers configuration and which notifier to use can be set in $HOME/.send-notification (See available parameters in current documentation).

Or the plugin can be configured using Gradle extension in targeted script:

notifier {
 implementation = 'notificationcenter'
 threshold {
 time = 10
 unit = java.util.concurrent.TimeUnit.SECONDS
 }
 growl {
 port = 23053
 host = 'localhost'
 password = 'azerty123'
 }

Here it is! No more excuses to forgot your ran a build somewhere!

Profile Maven build

Sun, 01 Feb 2015 22:33:00 +0200

Tools to measure time spent in your Maven builds.

By default Maven measure and display per module and total build time without further details. Hopefully you can use third party tools to profile each executions within your build.

maven-profiler
#

A tool I wrote some time ago because I didn’t find what I want. I use it to find which step is consuming most of the time and try to reduce the execution time.

It can generate a report (HTML or JSON) written in the .profiler folder inside the project.

To install it follow instructions available on github.

The report is created when we launch a build with the system property profile:

mvn install -Dprofile

By default, the HTML report is used, to switch for the JSON one:

mvn install -Dprofile -DprofileFormat=JSON

Report example:

{
	"name": "maven-profiler",
 "goals": "clean install",
 "date": "2015/01/17 15:28:49",
	"parameters": "{profile=true, profileFormat=JSON}",
 "projects": [{
	 "project": "maven-profiler",
		"time": "6.793 s",
 	"mojos": [{
	 	"mojo": "org.apache.maven.plugins:maven-surefire-plugin:2.18:test {execution: default-test}",
		 "time": "2.512 s"
		}, {
 		"mojo": "org.apache.maven.plugins:maven-shade-plugin:2.3:shade {execution: default}",
	 	"time": "1.458 s"
		}, {
 		"mojo": "org.codehaus.gmavenplus:gmavenplus-plugin:1.2:testCompile {execution: default}",
	 	"time": "818.3 ms"
		}, {
 		"mojo": "org.apache.maven.plugins:maven-compiler-plugin:3.2:compile {execution: default-compile}",
	 	"time": "538.7 ms"
		}, {
 		"mojo": "org.apache.maven.plugins:maven-source-plugin:2.4:jar-no-fork {execution: attach-sources}",
	 	"time": "248.5 ms"
		}, {
 		"mojo": "org.apache.maven.plugins:maven-jar-plugin:2.5:jar {execution: default-jar}",
	 	"time": "238.2 ms"
		}, {
 		"mojo": "org.apache.maven.plugins:maven-resources-plugin:2.7:resources {execution: default-resources}",
	 	"time": "171.7 ms"
 		}, {
 		"mojo": "org.codehaus.plexus:plexus-component-metadata:1.6:generate-metadata {execution: default}",
	 	"time": "170.5 ms"
		}, {
 		"mojo": "org.apache.maven.plugins:maven-enforcer-plugin:1.2:enforce {execution: enforce-maven}",
	 	"time": "126.0 ms"
		}, {
 		"mojo": "org.apache.maven.plugins:maven-clean-plugin:2.6.1:clean {execution: default-clean}",
	 	"time": "76.11 ms"
		}, {
 		"mojo": "org.apache.maven.plugins:maven-install-plugin:2.5.2:install {execution: default-install}",
	 	"time": "53.95 ms"
		}, {
 		"mojo": "org.apache.maven.plugins:maven-compiler-plugin:3.2:testCompile {execution: default-testCompile}",
	 	"time": "2.850 ms"
		}, {
 		"mojo": "org.apache.maven.plugins:maven-resources-plugin:2.7:testResources {execution: default-testResources}",
	 	"time": "2.518 ms"
	 }]
	}]
}

maven-timeline
#

This plugin construct a timeline with execution times. Formely developed by David Gageot, it is now maintained by the takari team.

To use it add the following extension in your pom.xml:

<extension>
 <groupId>io.takari.maven</groupId>
 <artifactId>maven-timeline</artifactId>
 <version>1.6</version>
</extension>

Two reports are generated, HTML and JSON.

{
 "start": "2015-02-01T19:18:18.738Z",
 "end": "2015-02-01T19:18:21.770Z",
 "dateTimeFormat": "iso8601",
 "events": [
 {
 "start": "2015-02-01T19:18:20.940Z",
 "end": "2015-02-01T19:18:21.095Z",
 "duration": 2380,
 "description": "com.github.jcgay.maven.color:maven-color-logback:package:jar:default-jar (2380 ms)",
 "trackNum": 1,
 "color": "blue",
 "durationEvent": true
 },
 {
 "start": "2015-02-01T19:18:19.136Z",
 "end": "2015-02-01T19:18:19.545Z",
 "duration": 830,
 "description": "com.github.jcgay.maven.color:maven-color-core:compile:compile:default-compile (830 ms)",
 "trackNum": 2,
 "color": "blue",
 "durationEvent": true
 },
 {
 "start": "2015-02-01T19:18:19.562Z",
 "end": "2015-02-01T19:18:19.564Z",
 "duration": 849,
 "description": "com.github.jcgay.maven.color:maven-color-agent:test-compile:testCompile:default-testCompile (849 ms)",
 "trackNum": 3,
 "color": "blue",
 "durationEvent": true
 },
 {
 "start": "2015-02-01T19:18:19.677Z",
 "end": "2015-02-01T19:18:19.818Z",
 "duration": 1103,
 "description": "com.github.jcgay.maven.color:maven-color-agent:package:jar:default-jar (1103 ms)",
 "trackNum": 3,
 "color": "blue",
 "durationEvent": true
 },
 
 ...
 
 {
 "start": "2015-02-01T19:18:20.801Z",
 "end": "2015-02-01T19:18:21.549Z",
 "duration": 2834,
 "description": "com.github.jcgay.maven.color:maven-color-log4j2:package:single:make-assembly (2834 ms)",
 "trackNum": 3,
 "color": "blue",
 "durationEvent": true
 }
 ]
}

tesla-profiler
#

Another profiler displaying build times in the console output.

The report is displayed when we launch the build with the system property maven.profile:

mvn install -Dmaven.profile

Result example:

com.github.jcgay.maven:maven-profiler:2.2-SNAPSHOT

 clean 81ms
 org.apache.maven.plugins:maven-clean-plugin:2.6.1 (default-clean) 80ms

 validate 145ms
 org.apache.maven.plugins:maven-enforcer-plugin:1.2 (enforce-maven) 145ms

 process-resources 198ms
 org.apache.maven.plugins:maven-resources-plugin:2.7 (default-resources) 198ms

 compile 588ms
 org.apache.maven.plugins:maven-compiler-plugin:3.2 (default-compile) 588ms

 process-classes 209ms
 org.codehaus.plexus:plexus-component-metadata:1.6 (default) 209ms

 process-test-resources 3ms
 org.apache.maven.plugins:maven-resources-plugin:2.7 (default-testResources) 3ms

 test-compile 1s 2ms
 org.apache.maven.plugins:maven-compiler-plugin:3.2 (default-testCompile) 3ms
 org.codehaus.gmavenplus:gmavenplus-plugin:1.2 (default) 998ms

 test 2s 670ms
 org.apache.maven.plugins:maven-surefire-plugin:2.18 (default-test) 2s 669ms

 package 2s 778ms
 org.apache.maven.plugins:maven-jar-plugin:2.5 (default-jar) 250ms
 org.apache.maven.plugins:maven-source-plugin:2.4 (attach-sources) 270ms
 org.apache.maven.plugins:maven-shade-plugin:2.3 (default) 2s 258ms

Happy profiling !

Color and desktop notifications for Maven

Sun, 04 May 2014 17:58:00 +0200

Maven, is not the sexiest tool available out there… Used within your IDE, it will be hidden but it deserve better inside your preferred shell.

Completion
#

There are a couple of bash completion scripts for Maven:

maven-bash-completion is a static list of plugins/goals/options. It is great, but each plugin must be described in the script to have auto completion suggestion.
Another one is available as a ubuntu package.

If you’re a zsh user:

with oh-my-zsh framework, the mvn plugin handle auto completion and you get a bunch of aliases with it too.
in zsh-completions, a script allow to discover plugin goals dynamically the first time you try to reach it (mvn plugin:<TAB>). First completion is a little bit longer but next ones will be immediate (Thanks Thomas Queste).

Desktop Notifications
#

A fast build is awesome… but it is not always possible to have one (for bad or good reasons by the way).
Having to stay in front of your shell to wait for it is not really useful, in that case a desktop notification at the end of the build is your savior.

maven-notifier
#

I have written a Maven extension to send a notification when a build ends: maven-notifier. It works with all major operating systems.
By default, the extension will try to find an available notifier on your system.
It is possible to configure which notifier you want to use (and many more) by creating a maven-notifier.properties file.

Notifier	Screenshot
Growl, for Windows and OS X.	maven-notifier-growl
Snarl, for Windows	maven-notifier-snarl
terminal-notifier, OS X
notification center OS X (since Mavericks)
notify-send for Linux
SystemTray since Java 6
Pushbullet	maven-notifier-pushbullet
Kdialog for KDE	maven-notifier-kdialog
notifu for Windows	maven-notifier-notifu
AnyBar for OS X and Linux	maven-notifier-anybar
Toaster for Windows 8
Notify since Java 6
BurntToast for Windows 10
Slack

Scripts
#

You can also use scripts that will wrap mvn command to get its status and then send a notification.

Growl with growlnotify : Integrate Growl with Maven, maven-growl
notification center with terminal-notifier : maven-notification-center
notify-send : Integrate notify-send with Maven.

Colors
#

Maven standard output is sad. It is not easy to differentiate the various level messages.

maven-color
#

maven-color colorize Maven output.

Since Maven 3.1.0, SLF4J is used internally, meaning you can choose which Logging framework you want to use.
This blog entry explains how you can customize your Maven installation to have colors in your logs with Log4j 2 or Logback. This is how maven-color works.

For older versions (between 3.0.x and 3.1.x) I have used Jansi to write log in color and a java agent to replace dynamically the logger implementation used by Maven. It works with interactive goals but it is kind of hard to install and maintain across Maven different versions. It breaks easily if Maven changes the way they implements their internal code. Grab it at maven-color.

Scripts
#

Some scripts are wrapping mvn command to colorize output:

This is sweet but it does not work with interactive goals. Don’t try to use maven-release-plugin or maven-archetype-plugin in interactive mode, it will poorly fail when you will need to input text.

All in one (OS X)
#

To gain installation time, I have written a brew formula.

brew tap jcgay/jcgay
brew install maven-deluxe

This will install latest Maven version, maven-notifier, maven-color and maven-profiler.

Conclusion
#

Xzibit

Thanks Xzibit for pimping my Maven !

Show Maven build plan

Sat, 22 Mar 2014 19:24:00 +0200

I often find myself in front of a POM scratching my head while trying to find what Maven will execute during my build. Since Maven 3 it is possible to calculate execution plan by simulating the build. Strangely there is not easy way do display it. Here is buildplan-maven-plugin.

Configuration
#

To easily use the plugin, add its groupId in your Maven configuration (ie settings.xml):

<pluginGroups>
 <pluginGroup>fr.jcgay.maven.plugins</pluginGroup>
</pluginGroups>

Show build plan
#

It is possible to list goals executed during a build. The simulated phase is deploy.

> mvn buildplan:list

[INFO] --- buildplan-maven-plugin:1.0:list (default-cli) @ maven-notifier ---
[INFO] ----------------------------------------------------------------------------------------------
[INFO] PLUGIN | PHASE | ID | GOAL
[INFO] ----------------------------------------------------------------------------------------------
[INFO] maven-resources-plugin | process-resources | default-resources | resources
[INFO] maven-compiler-plugin | compile | default-compile | compile
[INFO] plexus-component-metadata | process-classes | default | generate-metadata
[INFO] maven-resources-plugin | process-test-resources | default-testResources | testResources
[INFO] maven-compiler-plugin | test-compile | default-testCompile | testCompile
[INFO] maven-surefire-plugin | test | default-test | test
[INFO] maven-dependency-plugin | process-sources | get-logging-binding | copy
[INFO] maven-jar-plugin | package | default-jar | jar
[INFO] maven-shade-plugin | package | default | shade
[INFO] maven-assembly-plugin | | make-assembly | single
[INFO] maven-source-plugin | package | default | jar-no-fork
[INFO] maven-install-plugin | install | default-install | install
[INFO] maven-deploy-plugin | deploy | default-deploy | deploy

Show phases
#

A view per phase is available. This way, we can quickly see which plugins are used during a phase.

> mvn buildplan:list-phase

[INFO] --- buildplan-maven-plugin:1.0:list-phase (default-cli) @ maven-notifier ---
[INFO] install --------------------------------------------------------------------
[INFO] + maven-install-plugin | default-install | install
[INFO] process-resources ----------------------------------------------------------
[INFO] + maven-resources-plugin | default-resources | resources
[INFO] process-sources ------------------------------------------------------------
[INFO] + maven-dependency-plugin | get-logging-binding | copy
[INFO] test -----------------------------------------------------------------------
[INFO] + maven-surefire-plugin | default-test | test
[INFO] test-compile ---------------------------------------------------------------
[INFO] + maven-compiler-plugin | default-testCompile | testCompile
[INFO] process-test-resources -----------------------------------------------------
[INFO] + maven-resources-plugin | default-testResources | testResources
[INFO] process-classes ------------------------------------------------------------
[INFO] + plexus-component-metadata | default | generate-metadata
[INFO] compile --------------------------------------------------------------------
[INFO] + maven-compiler-plugin | default-compile | compile
[INFO] default-phase --------------------------------------------------------------
[INFO] + maven-assembly-plugin | make-assembly | single
[INFO] package --------------------------------------------------------------------
[INFO] + maven-jar-plugin | default-jar | jar
[INFO] + maven-shade-plugin | default | shade
[INFO] + maven-source-plugin | default | jar-no-fork
[INFO] deploy ---------------------------------------------------------------------
[INFO] + maven-deploy-plugin | default-deploy | deploy

Filtering phase using parameter buildplan.phase:

mvn buildplan:list-phase -Dbuildplan.phase=test

Show plugins
#

In this cas, executions are grouped by plugin.

> mvn buildplan:list-plugin

[INFO] --- buildplan-maven-plugin:1.0:list-plugin (default-cli) @ maven-notifier ---
[INFO] maven-deploy-plugin -----------------------------------------------------
[INFO] + deploy | default-deploy | deploy
[INFO] maven-source-plugin -----------------------------------------------------
[INFO] + package | default | jar-no-fork
[INFO] maven-assembly-plugin ---------------------------------------------------
[INFO] + | make-assembly | single
[INFO] maven-dependency-plugin -------------------------------------------------
[INFO] + process-sources | get-logging-binding | copy
[INFO] maven-resources-plugin --------------------------------------------------
[INFO] + process-resources | default-resources | resources
[INFO] + process-test-resources | default-testResources | testResources
[INFO] maven-jar-plugin --------------------------------------------------------
[INFO] + package | default-jar | jar
[INFO] maven-shade-plugin ------------------------------------------------------
[INFO] + package | default | shade
[INFO] maven-surefire-plugin ---------------------------------------------------
[INFO] + test | default-test | test
[INFO] maven-compiler-plugin ---------------------------------------------------
[INFO] + compile | default-compile | compile
[INFO] + test-compile | default-testCompile | testCompile
[INFO] maven-install-plugin ----------------------------------------------------
[INFO] + install | default-install | install
[INFO] plexus-component-metadata -----------------------------------------------
[INFO] + process-classes | default | generate-metadata

The parameter buildplan.plugin allow specific plugin filtering:

mvn buildplan:list-plugin -Dbuildplan.plugin=maven-compiler-plugin

This is it, your build plan will have no secret for you anymore !

Migration from WordPress to Pelican

Mon, 17 Mar 2014 20:31:00 +0200

Migration feedback of a WordPress blog to a static site built with Pelican.

Why ?
#

I just want a lightweight site. I tried to keep my WordPress instance clean but it has so much features I didn’t use that the tool was not meeting my needs. My shared hosting was not helping either and I was not satisfied by the average page loading time.

As I was already writing all my content with Markdown outside the Wordpress editor, I decided to go for a static site generator.

Pelican
#

Pelican is a static site generator written in Python. It supports Markdown, AsciiDoc and reStructuredText.
There is a lot of similar tools, and you certainly knows Jekyll or Octopress.
I choose Pelican because it has translation available out of the box. You can get it with others but not natively.

Install
#

For OS X:

brew install python
pip install virtualenv

## Install Pelican
mkdir -p ~/virtualenvs/pelican
virtualenv ~/virtualenvs/pelican
cd ~/virtualenvs/pelican
. bin/activate
pip install pelican
pip install Markdown
pip install beautifulsoup4
pip install typogrify
pip install webassets
pip install cssmin

For others OS installation details are here.

Activate Pelican environment
#

. ~/virtualenvs/pelican/bin/activate

Quit Pelican environment
#

deactivate

Create a site
#

Launch pelican-quickstart and follow instructions.

Welcome to pelican-quickstart v3.3.0.

This script will help you create a new Pelican-based website.

Please answer the following questions so this script can generate the files
needed by Pelican.


> Where do you want to create your new web site? [.] blog
> What will be the title of this web site? Jean-Christophe Gay
> Who will be the author of this web site? Jean-Christophe Gay
> What will be the default language of this web site? [en] fr
> Do you want to specify a URL prefix? e.g., http://example.com (Y/n) Y
> What is your URL prefix? (see above example; no trailing slash) http://jeanchristophegay.com
> Do you want to enable article pagination? (Y/n) Y
> How many articles per page do you want? [10]
> Do you want to generate a Fabfile/Makefile to automate generation and publishing? (Y/n) Y
> Do you want an auto-reload & simpleHTTP script to assist with theme and site development? (Y/n) Y
> Do you want to upload your website using FTP? (y/N) N
> Do you want to upload your website using SSH? (y/N) N
> Do you want to upload your website using Dropbox? (y/N) N
> Do you want to upload your website using S3? (y/N) N
> Do you want to upload your website using Rackspace Cloud Files? (y/N) N
Done. Your new project is available at /Users/jcgay/blog

Generated sources:

blog
├── Makefile
├── content
│   ├── (pages)
├── develop_server.sh
├── fabfile.py
├── output
├── pelicanconf.py
└── publishconf.py

2 directories, 5 files

Add content
#

Articles must be saved in content folder.
You can extract your WordPress articles using Pelican importer: http://docs.getpelican.com/en/3.3.0/importer.html#import

I have not tried it, I already had Markdown version of my content. It was just a matter of adding necessary metatada in each of my .md file.

To have an article recognized by Pelican, add metadata:

Title: git-p4 au secours de Perforce
Date: 2012-03-18 18:10
Category: Scm
Tags: git, git-p4, perforce, p4
Slug: git-p4-au-secours-de-perforce
Author: Jean-Christophe Gay
lang: fr

slug property allow to customize URL generated by Pelican. This way you will be able to keep your WordPress URL.

Choose a theme
#

Themes are available in the repository https://github.com/getpelican/pelican-themes.

For now I use elegant.

Clone the repository to have it accessible by Pelican configuration.

Plugins
#

Pelican is extendable by picking plugins. They are listed in the repository https://github.com/getpelican/pelican-plugins. Clone it.

Here are the active plugins on my installation:

sitemap: generate sitemap.xml file.
tipue_search: search engine for your content without using a third party service.
extract_toc: extract a table of contents.
optimize_images: compress jpeg and png images.
related_posts: display other articles in relation with the current one.
summary: set a summary limit using  directly in article.
assets: compile/minify static resources.

Configuration
#

Configuration is split in two files: pelicanconf.py et publishconf.py. The last one override former configuration with the production settings.

Parameters are described here.

I have not met any difficulties, two tips anyway.

Generate clean URLs:

 ARTICLE_URL = '{slug}'
 ARTICLE_SAVE_AS = '{slug}/index.html'

A folder slug is created for each article containing a single index.html file.

Copy files using metadata EXTRA_PATH_METADATA :

 EXTRA_PATH_METADATA = {
 'extra/humans.txt': {'path': 'humans.txt'},
 'extra/robots.txt': {'path': 'robots.txt'},
 'extra/.htaccess': {'path': '.htaccess'},
 }

Comments
#

If you were using WordPress comments, you must move them to a third party service like Disqus.
I was already using it, if you’re not, install this plugin.

In each article, add expected discussion feed identifier:

disqus_identifier: 7 http://jeanchristophegay.com/?p=7

It is read by elegant theme.

Redirect rules
#

Rewrite URLs which will disappear.

<IfModule mod_rewrite.c>
RewriteEngine On
RewriteBase /
RewriteRule feed/?$ feeds/rss.xml [R=301,L]
RewriteRule wp-content/uploads/2013/03/Capture-d’écran-2013-03-09-à-11.24.20-300x182.png images/p4merge-mini.png [R=301,L]
RewriteRule wp-content/uploads/2013/03/Capture-d’écran-2013-03-09-à-11.24.20.png images/p4merge.png [R=301,L]
# Redirect wp-content/uploads/2012/03/git-p4.png to images/git-p4.png
RewriteRule wp-content/uploads/[0-2][0-9][0-9][0-9]/[0-1][0-9]/([^/]+) images/$1 [R=301,L]
# Redirect 2012/04 to archives.html#2012
RewriteRule ([0-2][0-9][0-9][0-9])/[0-1][0-9]/? archives.html#$1 [R=301,NE,L]
# Redirect category/slug/ to categories.html#slug-ref
RewriteRule category/([^/]+)/? categories.html#$1-ref [R=301,NE,L]
# Redirect tag/slug/ to tags.html#slug-ref
RewriteRule tag/([^/]+)/? tags.html#$1-ref [R=301,NE,L]
# Redirect author/jcgay/ to /
RewriteRule author/jcgay/? / [R=301,L]
</IfModule> 

Test/Publish site
#

To generate site, launch make html && make serve.
Content is generated into output folder and publish at http://localhost:8000.

Production site should be generated using make publish. Upload the whole thing.

Conclusion
#

I like the final result, my blog is now generated from a simple git repository, content is versionned and the whole process is less cumbersome that what I was used to. Mission accomplished !

Jean-Christophe Gay

Use a unique property to set Maven version

Define the version with a property #

Continuous delivery friendly version #

Filtering pom at installation/deployment #

Conclusion #

Deploy Maven SNAPSHOT with Travis CI

Maven configuration #

Identification #

Repository settings #

Encrypt username and password #

Configuration de Travis CI #

Desktop notifications for Gradle

Gradle Build Announcements #

Gradle notifier #

Installation #

Initialization script #

Build script #

Configuration #

Profile Maven build

maven-profiler #

maven-timeline #

tesla-profiler #

Color and desktop notifications for Maven

Completion #

Desktop Notifications #

maven-notifier #

Scripts #

Colors #

maven-color #

Scripts #

All in one (OS X) #

Conclusion #

Show Maven build plan

Configuration #

Show build plan #

Show phases #

Show plugins #

Migration from WordPress to Pelican

Why ? #

Pelican #

Install #

Activate Pelican environment #

Quit Pelican environment #

Create a site #

Add content #

Choose a theme #

Plugins #

Configuration #

Comments #

Redirect rules #

Test/Publish site #

Conclusion #

Define the version with a property
#

Continuous delivery friendly version
#

Filtering pom at installation/deployment
#

Conclusion
#

Maven configuration
#

Identification
#

Repository settings
#

Encrypt username and password
#

Configuration de Travis CI
#

Gradle Build Announcements
#

Gradle notifier
#

Installation
#

Initialization script
#

Build script
#

Configuration
#

maven-profiler
#

maven-timeline
#

tesla-profiler
#

Completion
#

Desktop Notifications
#

maven-notifier
#

Scripts
#

Colors
#

maven-color
#

Scripts
#

All in one (OS X)
#

Conclusion
#

Configuration
#

Show build plan
#

Show phases
#

Show plugins
#

Why ?
#

Pelican
#

Install
#

Activate Pelican environment
#

Quit Pelican environment
#

Create a site
#

Add content
#

Choose a theme
#

Plugins
#

Configuration
#

Comments
#

Redirect rules
#

Test/Publish site
#

Conclusion
#