Anyone hosting projects built with maven on Github will probably be interested in the Github Maven plugins
At the moment there are two plugins, one for uploading artifacts to the download section of your Github project, and another for uploading your maven site to the gh-pages branch of your repository.
You need to put something like this, or a bit cleverer, in your maven settings.xml:
<profiles> <profile> <id>github-properties</id> <properties> <github.global.userName>myusername</github.global.userName> <github.global.password>mypassword</github.global.password> </properties> </profile> </profiles> <activeProfiles> <activeProfile>github-properties</activeProfile> </activeProfiles> |
site plugin
Then configure the plugins in your project. For the site plugin you need something like this, which will upload to github each tiem you run the site goal in maven.
<build> <plugins> <plugin> <groupId>com.github.github</groupId> <artifactId>site-maven-plugin</artifactId> <version>0.5</version> <executions> <execution> <goals> <goal>site</goal> </goals> <phase>site</phase> <configuration> <message>Creating site for ${project.version}</message> </configuration> </execution> </executions> </plugin> |
multi-module projects
I’m not clear on how the multi-module support is supposed to work. The way I have got it to work is by using `path` and `merge` in the modules:
<configuration> <path>modulename</path> <merge>true</merge> ... </configuration> |
my theory is that if you build `site` in your parent project, then it will be uploaded first, clearing the whole site. Then each of the sub modules will be built merging each site into the parent site in the correct subdirectory. This seems to work, but the top level project run with `merge=false` wipes out you site for a while until the child modules complete. So if your project takes a while to build (or fails!) visitors might get disappointed. The only alternative to this seems to be to have `merge=true` on all the projects, but that will leave anything that doesn’t get overwritten unaffected. YMMV.
download plugin
You can have each of your releases uploaded to github for other people to download. I use a profile to only sign and upload my release builds and not every snapshot.
<profile> <id>release-sign-artifacts</id> <activation> <property> <name>performRelease</name> <value>true</value> </property> </activation> <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-gpg-plugin</artifactId> <version>1.4</version> <executions> <execution> <id>sign-artifacts</id> <phase>verify</phase> <goals> <goal>sign</goal> </goals> </execution> </executions> </plugin> <plugin> <groupId>com.github.github</groupId> <artifactId>downloads-maven-plugin</artifactId> <version>0.4</version> <executions> <execution> <goals> <goal>upload</goal> </goals> <phase>install</phase> <configuration> <description>${project.version} release of ${project.name}</ description> <override>true</override> <includeAttached>true</includeAttached> </configuration> </execution> </executions> </plugin> </plugins> </build> </profile> |
The more I use maven and github for Open Source development the better it gets, and this github integration is super-smooth. I have pretty much single click global publishing of my whole project source, documentation and artifacts. Combined with the super easy and free nexus and maven central access provided by sonatype OSS and the jenkins CI server instance provied by cloudbees this is as close to as good a dev environment as you can get – and all for no money. Oh yeah, and I forgot about the eclipse maven integration. We’ve come along way.