From 3132466e0644de936acb212773db21637ff35834 Mon Sep 17 00:00:00 2001 From: Johannes Rudolph Date: Wed, 23 May 2012 12:35:49 +0200 Subject: [PATCH] README and notes --- README.md | 22 ++++++++++++++++------ notes/0.6.0.markdown | 12 ++++++++++++ notes/about.markdown | 3 +++ 3 files changed, 31 insertions(+), 6 deletions(-) create mode 100644 notes/0.6.0.markdown create mode 100644 notes/about.markdown diff --git a/README.md b/README.md index a4599181e..7a3a69067 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ How To Use For sbt 0.11, add sbt-dependency-graph as a dependency in `project/plugins.sbt`: ```scala -addSbtPlugin("net.virtual-void" % "sbt-dependency-graph" % "0.5.2") +addSbtPlugin("net.virtual-void" % "sbt-dependency-graph" % "0.6.0") ``` *Note*: The organization has recently been changed to `net.virtual-void`. @@ -34,12 +34,22 @@ object Plugins extends Build { Then, add the following in your `build.sbt`: ```scala -seq(net.virtualvoid.sbt.graph.Plugin.graphSettings: _*) +net.virtualvoid.sbt.graph.Plugin.graphSettings ``` -In sbt you can then use the `dependency-graph` task in sbt to generate a graphml file -in `target/dependencies.graphml`. Use e.g. [yEd](http://www.yworks.com/en/products_yed_about.html) -to format the graph to your needs. +Tasks & Settings +---------------- + + * `dependency-graph`: Shows an ASCII graph of your dependency on the sbt console + * `dependency-graph-ml`: Generates a .graphml file with your dependencies to `target/dependencies-.graphml`. + Use e.g. [yEd](http://www.yworks.com/en/products_yed_about.html) to format the graph to your needs. + * `dependency-graph-ml-file`: a setting which allows configuring the output path of `dependency-graph-ml`. + * `ivy-report`: let's ivy generate the resolution report for you project. Use + `show ivy-report` for the filename of the generated report + +All tasks can be scoped to a configuration to get the report for a specific configuration. `test:dependency-graph`, +for example, prints the dependencies in the `test` configuration. If you don't specify any configuration, `compile` is +assumed as usual. Standalone usage ---------------- @@ -52,7 +62,7 @@ and calling it like `scala sbt-dependency-graph-0.5.1.jar Inner Workings -------------- -sbt/Ivy's `deliver-local` task create ivy-report xml-files inside `.ivy2/cache`. You can +sbt/Ivy's `update` task create ivy-report xml-files inside `.ivy2/cache`. You can just open them with your browser to look at the dependency report for your project. This project takes the report xml of your project and creates a graphml file out of it. (BTW, ivy can create graphml files itself, but since I didn't want to spend to much time getting diff --git a/notes/0.6.0.markdown b/notes/0.6.0.markdown new file mode 100644 index 000000000..0146dbd92 --- /dev/null +++ b/notes/0.6.0.markdown @@ -0,0 +1,12 @@ +New features in this version: + + * `dependency-graph` task now prints the dependency graph to the console + (contributed by @gseitz) + * `dependency-graph-ml` contains now the old functionality of `dependency-graph` + which generates a `.graphml` file. Nodes contain the dependency version as well (contributed by @gseitz). + * The output filename of `dependency-graph-ml` has been changed to include the configuration name. It is now + configurable using the `dependency-graph-ml-file` setting. + * The common `scalaVersion in update` idiom to support Scala 2.9.1 libraries in a + Scala 2.9.2 broke the plugin in 0.5.2, because it wouldn't find the ivy report xml file + any more. This was fixed. + * All tasks are scoped by configuration. diff --git a/notes/about.markdown b/notes/about.markdown new file mode 100644 index 000000000..01fbb70cf --- /dev/null +++ b/notes/about.markdown @@ -0,0 +1,3 @@ +[sbt-dependency-graph][gh] is an sbt plugin to visualize dependencies of your build. + +[gh]:https://github.com/jrudolph/sbt-dependency-graph/ \ No newline at end of file