Comments on: GitHub Pages: publish your Grails plugin docs

By: Daniel

Daniel — Sat, 26 Feb 2011 16:46:26 +0000

Hi, Peter. Based on PublishGithub.groovy, i’ve done something similar for Google Code:

http://code.google.com/p/grails-batch-launcher-plugin/source/browse/trunk/scripts/PublishGooglecode.groovy

Thanks.

Best regards,

Daniel.

By: Chris

Chris — Wed, 16 Feb 2011 14:31:56 +0000

Great post! I have been toying with the idea of building a plugin similar to the maven site plugin so that I can aggregate docs, coverage, metrics, etc. into one coherent site and this is a great starting point.

By: "Hmm!" Ich erinnere mich Kästchen zwar geräumt, aber immer Frack, ein schimmernder Hut, adrette braune Gamaschen Mein Freund auf höchst eigenwillige Weise. | Schon so gut wie gewonnen.

Fri, 21 Jan 2011 18:06:50 +0000

[...] der sagte ich, über eilte ich zu sagte Schmidt, »ist es von der Straße. Und wer GitHub Pages: publish your Grails plugin docs @ Peter Ledbrook sind die hier?Dann ging ja! Als wir abfuhren, konnte mit ich selbst sie mit welche Gentleman, [...]

By: Peter

Peter — Tue, 28 Sep 2010 09:17:08 +0000

@Scott How do you plan to commit the pages if the clone’s remote URL is the HTTP one? That won’t allow you to push changes. Nonetheless, you’re right that the script is hardcoded to the git:// URL, when it could be https://.

As for ‘plugin.xml’, note that the article says that it should be removed from the remote git repository. You do still need the file locally. The package-plugin command should create it, so I’m not sure what’s going on there.

There’s nothing stopping you from creating a plugin out of this In fact, a number of plugin developers seem to be using this approach, so I’m surprised a plugin hasn’t been created for it yet. I’m afraid I’ve barely used it since I created the script, so I’m rather loathe to create and maintain one. Perhaps this is something for the Grails Plugin Collective to manage.

By: Scott Ryan

Scott Ryan — Tue, 28 Sep 2010 03:52:09 +0000

We tried the plugin on our community plugins and get a number of errors. The git url could not be located as it does not have a user name in it but is http://github.com/multi-tenant/grails-multi-tenant-core and then the script continued on and we got an error that the plugin.xml file was not found although the above post tells us to remove it. I tried packaging the plugin first but no luck there either. It would be cool if this was packaged into a plugin as it is rather tedious to set up for multiple projects with a lot of cutting and pasting which is error prone. I will keep pushing forward but any ideas would be helpful. I will try to post on the grails list as well.

By: Peter

Peter — Tue, 31 Aug 2010 09:23:17 +0000

Thanks Luke. I’ve pushed the changed so the script in the GWT plugin has the fix.

By: Luke Daley

Luke Daley — Tue, 31 Aug 2010 02:10:22 +0000

The following patch will make the publish-github script work with 1.3:

— untitled
+++ (clipboard)
@@ -58,7 +58,13 @@
// We have to generate the docs on the current branch because the
// ‘docs’ target depends on ‘compile’, which of course requires all
// the source files.
- def docsDir = new File(“${basedir}/docs”)
+ def docsDir
+ try {
+ docsDir = grailsSettings.docsOutputDir
+ } catch (MissingPropertyException e) {
+ docsDir = new File(“${basedir}/docs”)
+ }
+
ant.delete(dir: docsDir.absolutePath)
docs()

By: Armbruster IT Blog » new Grails plugin released: modproxybalancer

Armbruster IT Blog » new Grails plugin released: modproxybalancer — Tue, 25 May 2010 12:18:42 +0000

[...] note: this is my first Grails plugin with it’s sources residing on github.com. Thanks to Peter Ledbrook’s excellent blog post, I was able to use GitHub pages for the documentation. Categories: Uncategorized Tags: [...]

By: GitHub Pages: publica tu documentación de plugins de Grails (inglés) - Observatorio de Grails

Fri, 12 Mar 2010 11:08:15 +0000

[...] información sobre GitHub Pages: publish your Grails plugin doc (traducido al [...]

By: Mike Brevoort

Mike Brevoort — Mon, 08 Mar 2010 13:18:13 +0000

Very clever Peter. To Graeme’s point would be great if there were a more turnkey way to do this, but to me it would make sense that this would integrate more tightly into the Plugin Portal. I especially like the change notification on the plugin portal docs (though not 25 emails when someone is editing large changes and incrementally saving).

Is it more appropriate to consider what improvements should be made to the plugin portal? Subpage support with the ability to publish all docs from script? Also, would be cool if within core a dev plugin there was a way to fire up a local webserver to serve the grails doc for the version you’re running as well as a consolidated collection of plugin docs for all the plugins installed in the project.

I like the though of trying to maintain consolidated documentation for plugins.