Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Maven site can now be published to github pages #875

Merged
merged 1 commit into from

3 participants

@jendave

The Maven site can now be published to Github pages using this command:
mvn clean site site:stage site:stage-deploy scm-publish:publish-scm

You can see a test run of the site and upload at http://jendave.github.io/jruby/

@jendave

In case anyone asks, I did not use the official github site plugin because it has a 5000 blob limit, which is an issue for such a large project. I also had numerous errors during site uploads with it. The Maven scm-publish plugin proved to be much more capable.

@mkristian
Collaborator
@jendave

I have had problems generating the Maven site for the Integration Tests, so I have the site plugin skip that module (this is in a prior PR). You can see that setting in the pom.xml for the test module. Unfortunately, the site goal still creates the link. Thanks.

@headius headius merged commit 1e834ce into from
@headius
Owner

I went ahead and merged it.

We do not currently have gh-pages for JRuby, but I kinda like the idea of our github page for JRuby basically being source/site/statistic-related information about the codebase.

I can certanly spin up a gh-pages branch for folks to push to. In fact, I'll do that now.

@headius
Owner

Ok...jruby/jruby@gh-pages branch is created with a dummy index.html. It's accessible at http://jruby.github.io/jruby/ for now.

@jendave

Thanks! Someone with access will have to run
'mvn clean site site:stage site:stage-deploy scm-publish:publish-scm'

Make sure to put something like this into your settings.xml


github
username
password

@jendave jendave deleted the branch
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Jul 10, 2013
  1. @jendave
This page is out of date. Refresh to see the latest.
Showing with 58 additions and 5 deletions.
  1. +2 −0  README.md
  2. +56 −5 pom.xml
View
2  README.md
@@ -50,6 +50,8 @@ See [README.test](docs/README.test.md) for more information.
Visit http://jruby.org for more information.
+Visit http://jruby.github.io/jruby for the Maven Site documentation.
+
## License
Read the [COPYING](COPYING) file.
View
61 pom.xml
@@ -31,14 +31,23 @@
<json.version>1.7.3</json.version>
<base.java.version>1.6</base.java.version>
<main.basedir>${project.basedir}</main.basedir>
+ <github.global.server>github</github.global.server>
</properties>
<scm>
<connection>scm:git:git://github.com/jruby/jruby.git</connection>
<developerConnection>scm:git:ssh://git@github.com/jruby/jruby.git</developerConnection>
- <url>http://github.com/jruby/jruby</url>
+ <url>https://github.com/jruby/jruby</url>
</scm>
+ <distributionManagement>
+ <site>
+ <id>gh-pages</id>
+ <name>JRuby Site</name>
+ <url>https://github.com/jruby/jruby</url>
+ </site>
+ </distributionManagement>
+
<build>
<defaultGoal>package</defaultGoal>
<pluginManagement>
@@ -116,6 +125,13 @@
<artifactId>lifecycle-mapping</artifactId>
<version>1.0.0</version>
</plugin>
+
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-scm-publish-plugin</artifactId>
+ <version>1.0-beta-2</version>
+ </plugin>
+
</plugins>
</pluginManagement>
@@ -127,6 +143,41 @@
<port>9000</port>
<tempWebappDirectory>${basedir}/target/site/tempdir</tempWebappDirectory>
</configuration>
+ <executions>
+ <execution>
+ <id>stage-for-scm-publish</id>
+ <phase>post-site</phase>
+ <goals>
+ <goal>stage</goal>
+ </goals>
+ <configuration>
+ <skipDeploy>false</skipDeploy>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+
+ <plugin>
+ <!-- To publish website to jruby.github.io/jruby execute:
+ mvn clean site site:stage site:stage-deploy scm-publish:publish-scm
+ -->
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-scm-publish-plugin</artifactId>
+ <version>1.0-beta-2</version>
+ <configuration>
+ <scmBranch>gh-pages</scmBranch>
+ <pubScmUrl>scm:git:git@github.com:jruby/jruby.git</pubScmUrl>
+ <tryUpdate>true</tryUpdate>
+ </configuration>
+ <executions>
+ <execution>
+ <id>scm-publish</id>
+ <phase>site-deploy</phase>
+ <goals>
+ <goal>publish-scm</goal>
+ </goals>
+ </execution>
+ </executions>
</plugin>
</plugins>
</build>
@@ -205,14 +256,14 @@
</propertyExpansion>
</configuration>
</plugin>
- <plugin>
+ <!-- <plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>cobertura-maven-plugin</artifactId>
<version>2.5.1</version>
<configuration>
<aggregate>true</aggregate>
</configuration>
- </plugin>
+ </plugin> -->
<plugin>
<artifactId>maven-dependency-plugin</artifactId>
<version>2.8</version>
@@ -266,7 +317,7 @@
<targetJdk>1.6</targetJdk>
</configuration>
</plugin>
- <plugin>
+ <!-- <plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jxr-plugin</artifactId>
<version>2.3</version>
@@ -274,7 +325,7 @@
<linkJavadoc>true</linkJavadoc>
<aggregate>true</aggregate>
</configuration>
- </plugin>
+ </plugin> -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-report-plugin</artifactId>
Something went wrong with that request. Please try again.