mirror of https://github.com/sbt/sbt.git
bump version to 0.8.0 and update README to reflect changes
This commit is contained in:
Johannes Rudolph
parent
eac58262d4
commit
a821b27809
2
NOTICE
2
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.
|
||||
|
|
|
|||
53
README.md
53
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 <organization> <module> <revision>`: 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 <organization> <module> <revision>`: 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-<config>.graphml`.
|
||||
* `dependencyLicenseInfo`: show dependencies grouped by declared license
|
||||
* `dependencyGraphMl`: Generates a `.graphml` file with the project's dependencies to `target/dependencies-<config>.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-<config>.dot`.
|
||||
* `dependencyDot`: Generates a .dot file with the project's dependencies to `target/dependencies-<config>.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
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
@ -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"))
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue