Permalink
Browse files

small updates, and add (near-empty) plugin documentation

  • Loading branch information...
1 parent e18bf07 commit 4508e8989b951fbd5c2788e00a8ab4463dba6232 @smartiniOnGitHub committed Sep 14, 2012
@@ -8,6 +8,7 @@ class GrailsAkkaGrailsPlugin {
// resources that are excluded from plugin packaging
def pluginExcludes = [
"grails-app/views/error.gsp"
+ , "src/docs/"
]
def title = "Grails Akka Plugin" // Headline display name of the plugin
View
Oops, something went wrong.
View
@@ -42,5 +42,5 @@ Documentation
See the Plugin documentation (sources under src/docs/).
Home Page for the project (and sources) on GitHUB:
-[grails-akka](https://github.com/smartiniOnGitHub/grails-akka`)
+[grails-akka](https://github.com/smartiniOnGitHub/grails-akka/)
View
@@ -4,7 +4,10 @@ grails-akka - TODO
TODO
----
-- try to exclude the transitivity of scala (at least put a commented line in the BuildConfig of the plugin) ...
+- exclude the transitivity of scala, to avoid dependency errors in the grails dependency-report ...
+ + put exclusions for this in the BuildConfig of the plugin, until I get 0 evicted (in build, compile, and runtime)... ok
+ * I commented all the exclusions for now otherwise a compile error will happen ...
+ just for reference, but could be the wrong way to do this, so let's see later if/how to fix this
- try with some local actor:
+ then verify them from the test webapp ...
@@ -15,13 +18,16 @@ TODO
- package the plugin and verify if all is good ...
+ add by hand README.md, NOTICE, LICENSE, and RELEASE-NOTES and README if present ...
+ + add by hand CHANGES.md with inside the full history of changes
+ * better, put this in plugin docs
- for release 1.0:
+ verify the info put in readme.md
* and then, create another test webapp (but not inline here) where to install it, following only readme info, to ensure they are right ...
+ add some long-running actor, for example giving it the delay ...
* ok, but up to now it doesn't seem to block execution for the given delay ... verify better, to make it work
+ + test the right behaviour (to be sure that Thread suspend/resume in done the right way), with a stress test ...
+ make an akkaService, and test it
* do it in the test webapp, because probably in the plugin it would be hard to have it so much generalized ...
+ fix TODO in code ...
@@ -1,10 +1,13 @@
// grails.servlet.version = "3.0" // verify if makes sense to enable this even here ...
grails.project.class.dir = "target/classes"
+// grails.project.docs.output.dir = 'docs/manual'
grails.project.test.class.dir = "target/test-classes"
grails.project.test.reports.dir = "target/test-reports"
grails.project.source.level = 1.6
grails.project.target.level = 1.6
-//grails.project.war.file = "target/${appName}-${appVersion}.war"
+// grails.project.war.file = "target/${appName}-${appVersion}.war"
+// grails.project.work.dir = 'target'
+
def akkaVersion = '2.0.3'
@@ -25,8 +28,20 @@ grails.project.dependency.resolution = {
dependencies {
// specify dependencies here under either 'build', 'compile', 'runtime', 'test' or 'provided' scopes eg.
- compile("com.typesafe.akka:akka-actor:$akkaVersion", "com.typesafe.akka:akka-remote:$akkaVersion")
- test("com.typesafe.akka:akka-testkit:$akkaVersion")
+ compile("com.typesafe.akka:akka-actor:$akkaVersion", "com.typesafe.akka:akka-remote:$akkaVersion") {
+ // disable excludes, or compile errors will happen ...
+ // // exclude, to avoid version conflict
+ // excludes 'scala-library'
+ // excludes 'commons-codec'
+ // excludes 'commons-io'
+ }
+ test("com.typesafe.akka:akka-testkit:$akkaVersion") {
+ // disable excludes, or compile errors will happen ...
+ // // exclude, to avoid version conflict
+ // excludes 'scala-library'
+ // excludes 'commons-codec'
+ // excludes 'commons-io'
+ }
}
plugins {
@@ -22,3 +22,8 @@ log4j = {
warn 'org.mortbay.log'
}
+
+
+grails.doc.authors = 'Sandro Martini'
+grails.doc.license = 'Apache License 2.0'
+grails.doc.title = 'Akka Plugin'
@@ -2,5 +2,7 @@ h1. Grails-Akka
h2. Introduction
-Makes possible to use Akka Actors from a Grails webapp.
+This plugin makes it easy to use [Akka](http://akka.io/) Actors (both local and remote) from a Grails webapp.
+
+All using standard Groovy / Java code.
@@ -0,0 +1,5 @@
+h4. History
+
+* September 2012
+** 0.5 release
+*** First public version of the plugin, with some basic features, and the inline test webapp
@@ -0,0 +1,5 @@
+h1. Grails-Akka
+
+h2. Usage
+
+TODO ...
@@ -0,0 +1,5 @@
+h1. Grails-Akka
+
+h2. Tutorials
+
+TODO ...
@@ -0,0 +1,5 @@
+h1. Grails-Akka
+
+h2. Troubleshooting
+
+TODO ...

0 comments on commit 4508e89

Please sign in to comment.