From a821b278093e25fdaba8bf511c6e93865a2cfad2 Mon Sep 17 00:00:00 2001 From: Johannes Rudolph Date: Wed, 25 Nov 2015 16:50:30 +0100 Subject: [PATCH] bump version to 0.8.0 and update README to reflect changes --- NOTICE | 2 +- README.md | 53 ++++++++++++++++---------------------------- notes/0.8.0.markdown | 14 ++++++++++++ project.sbt | 2 +- 4 files changed, 35 insertions(+), 36 deletions(-) create mode 100644 notes/0.8.0.markdown diff --git a/NOTICE b/NOTICE index 59536b942..282e7e8e5 100644 --- a/NOTICE +++ b/NOTICE @@ -1,4 +1,4 @@ -Graph.scala is copied from sbt and is distributed under the following license: +AsciiTreeLayout.scala is copied from sbt and is distributed under the following license: Copyright (c) 2008, 2009, 2010 Steven Blundy, Josh Cough, Mark Harrah, Stuart Roebuck, Tony Sloane, Vesa Vilhonen, Jason Zaugg All rights reserved. diff --git a/README.md b/README.md index 1d029e04f..10b0146ce 100644 --- a/README.md +++ b/README.md @@ -3,21 +3,11 @@ sbt-dependency-graph Visualize your project's dependencies. -New in 0.8.x ------------- +Preliminaries +------------- - * sbt >= 0.13.8 is now required (for older sbt versions see [0.7.5](https://github.com/jrudolph/sbt-dependency-graph/tree/0.7)) - * This plugin is now an auto-plugin and it is automatically enabled. - * Code was restructured which touched a lot of the classes but didn't change the function or syntax of settings and tasks. - * A new backend was implemented which accesses the in-memory dependency data structures of sbt directly. The plugin doesn't - require accessing the ivy report XML any more (the old backend can still be wired in for comparisons if needed) which - should have solved the race condition and the dreaded `FileNotFoundException` ([#39](https://github.com/jrudolph/sbt-dependency-graph/issues/39)) - in multi-module projects. - * (experimental) the DOT graph can now be shown in the browser. Try the new `dependencyBrowseGraph` task. - * A few smaller bug fixes. - -The README has not yet been completely overhauled so please send a PR against the 0.8 branch if you find something missing -or inaccurate. +Starting with version 0.8.0, the plugin will only work for sbt-projects that use sbt >= 0.13.8. See +the [0.7 branch](https://github.com/jrudolph/sbt-dependency-graph/tree/0.7) for older versions that still work with sbt < 0.13.8. How To Use ---------- @@ -27,26 +17,30 @@ install it as a [global plugin] so that you can use it in any SBT project withou this, add the plugin dependency to `~/.sbt/0.13/plugins/plugins.sbt`: ```scala -addSbtPlugin("net.virtual-void" % "sbt-dependency-graph" % "0.8.0-beta1") +addSbtPlugin("net.virtual-void" % "sbt-dependency-graph" % "0.8.0") ``` +This plugin is an auto-plugin which will be automatically enabled. + +To add the plugin only to a single project, put this line into `project/plugins.sbt` of your project, instead. + Main Tasks ---------- - * `dependency-tree`: Shows an ASCII tree representation of the project's dependencies - * `dependency-graph`: Shows an ASCII graph of the project's dependencies on the sbt console - * `dependency-browse-graph`: Opens a browser window with a visualization of the dependency graph (courtesy of graphlib-dot + dagre-d3). - * `what-depends-on `: Find out what depends on an artifact. Shows a reverse dependency + * `dependencyTree`: Shows an ASCII tree representation of the project's dependencies + * `dependencyBrowseGraph`: Opens a browser window with a visualization of the dependency graph (courtesy of graphlib-dot + dagre-d3). + * `dependencyGraph`: Shows an ASCII graph of the project's dependencies on the sbt console + * `whatDependsOn `: Find out what depends on an artifact. Shows a reverse dependency tree for the selected module. - * `dependency-license-info`: show dependencies grouped by declared license - * `dependency-graph-ml`: Generates a .graphml file with the project's dependencies to `target/dependencies-.graphml`. + * `dependencyLicenseInfo`: show dependencies grouped by declared license + * `dependencyGraphMl`: Generates a `.graphml` file with the project's 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-dot`: Generates a .dot file with the project's dependencies to `target/dependencies-.dot`. + * `dependencyDot`: Generates a .dot file with the project's dependencies to `target/dependencies-.dot`. Use [graphviz](http://www.graphviz.org/) to render it to your preferred graphic format. - * `ivy-report`: let's ivy generate the resolution report for you project. Use - `show ivy-report` for the filename of the generated report + * `ivyReport`: let's ivy generate the resolution report for you project. Use + `show ivyReport` 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`, +All tasks can be scoped to a configuration to get the report for a specific configuration. `test:dependencyGraph`, for example, prints the dependencies in the `test` configuration. If you don't specify any configuration, `compile` is assumed as usual. @@ -93,19 +87,10 @@ Known issues * #19: There's an unfixed bug with graph generation for particular layouts. Workaround: Use `dependency-tree` instead of `dependency-graph`. - * #12: Excluded dependencies will be shown in the graph in sbt < 0.12, works with later versions - -Credits -------- - - * Matt Russell (@mdr) for contributing the ASCII graph layout. - * berleon (@berleon) for contributing rendering to dot. License ------- -Copyright (c) 2011, 2012, 2013, 2014, 2015 Johannes Rudolph - Published under the [Apache License 2.0](http://en.wikipedia.org/wiki/Apache_license). [global plugin]: http://www.scala-sbt.org/0.13/tutorial/Using-Plugins.html#Global+plugins diff --git a/notes/0.8.0.markdown b/notes/0.8.0.markdown new file mode 100644 index 000000000..5008fe3b7 --- /dev/null +++ b/notes/0.8.0.markdown @@ -0,0 +1,14 @@ +This is a major release which brings a few breaking changes. + +New features: + - (experimental) open dependency graph directly in the browser with `dependencyBrowseGraph` ([#24](https://github.com/jrudolph/sbt-dependency-graph/issues/24)) + +Other changes: + - sbt >= 0.13.8 is now required + - this plugin is now an auto-plugin and it is automatically enabled ([#51](https://github.com/jrudolph/sbt-dependency-graph/issues/51)) + - a new backend was implemented which accesses the in-memory dependency data structures of sbt directly. The plugin doesn't + require accessing the ivy report XML any more (the old backend can still be wired in for comparisons if needed) which + should have solved the race condition and the dreaded `FileNotFoundException` ([#39](https://github.com/jrudolph/sbt-dependency-graph/issues/39)) + in multi-module projects. + - code was restructured which touched a lot of the classes but didn't change the function or syntax of settings and tasks. + - [fixed #77](https://github.com/jrudolph/sbt-dependency-graph/issues/77) \ No newline at end of file diff --git a/project.sbt b/project.sbt index 9026b5536..e45164a0f 100644 --- a/project.sbt +++ b/project.sbt @@ -4,7 +4,7 @@ name := "sbt-dependency-graph" organization := "net.virtual-void" -version := "0.8.0-beta1" +version := "0.8.0" homepage := Some(url("http://github.com/jrudolph/sbt-dependency-graph"))