Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rtimush/sbt-updates
sbt plugin that can check Maven and Ivy repositories for dependency updates
https://github.com/rtimush/sbt-updates
sbt sbt-plugin scala
Last synced: about 1 month ago
JSON representation
sbt plugin that can check Maven and Ivy repositories for dependency updates
- Host: GitHub
- URL: https://github.com/rtimush/sbt-updates
- Owner: rtimush
- License: bsd-3-clause
- Created: 2012-10-07T17:20:50.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T08:10:14.000Z (about 2 months ago)
- Last Synced: 2024-10-28T09:40:01.164Z (about 2 months ago)
- Topics: sbt, sbt-plugin, scala
- Language: Scala
- Homepage:
- Size: 565 KB
- Stars: 760
- Watchers: 22
- Forks: 55
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-sbt-plugins - sbt-updates - SBT plugin that can check maven repositories for dependency updates (OTHER)
README
sbt-updates
==================
Display your sbt project's dependency updates.
Update information is obtained from the maven metadata.
There is also a limited support for Ivy repositories hosted on BinTray.
If your project uses `crossScalaVersions` you will be presented only with updates available for all scala versions.
Requirements
==============
sbt 0.13.9 and later. sbt 1.x is supported since version 0.3.1.
Installation
============
### Stable version
Create a `~/.sbt/1.0/plugins/sbt-updates.sbt` file (for sbt 1.x series), or `~/.sbt/0.13/plugins/sbt-updates.sbt` (for sbt 0.13.x series) with the following content:
```
addSbtPlugin("com.timushev.sbt" % "sbt-updates" % "x.x.x")
```
The latest version is [](https://maven-badges.herokuapp.com/maven-central/com.timushev.sbt/sbt-updates/)
### Snapshot version
Choose one of versions available on [Sonatype](https://oss.sonatype.org/content/repositories/snapshots/com/timushev/sbt/sbt-updates_2.12_1.0/). Then create a `~/.sbt/1.0/plugins/sbt-updates.sbt` file (for sbt 1.x series), or `~/.sbt/0.13/plugins/sbt-updates.sbt` (for sbt 0.13.x series) with the following content:
```
resolvers += Resolver.sonatypeRepo("snapshots")
addSbtPlugin("com.timushev.sbt" % "sbt-updates" % "x.x.x-y+gzzzzzzz-SNAPSHOT")
```
Note, that snapshots are not updated automatically.
Tasks
=====
* `dependencyUpdates`: show a list of project dependencies that can be updated,
* `dependencyUpdatesReport`: writes a list of project dependencies to a file.
Settings
========
* `dependencyUpdatesReportFile`: report file location, `target/dependency-updates.txt` by default.
* `dependencyUpdatesFilter`: filter matching dependencies that should be included to update reporting.
* `dependencyUpdatesFailBuild`: `dependencyUpdates` task will fail a build if updates found.
* `dependencyAllowPreRelease`: when enabled, pre-release dependencies will be reported as well.
#### Deprecated Settings
* `dependencyUpdatesExclusions`: filter matching dependencies that should be excluded from update reporting.
Exclusions
==========
You can exclude some modules from update checking:
```
dependencyUpdatesFilter -= moduleFilter(organization = "org.scala-lang")
```
sbt plugin updates
=============
If `sbt-updates` is installed in your global file you can get updates for sbt plugins by using the `reload plugins` command:
```
> reload plugins
...
> dependencyUpdates
[info] Found 2 dependency updates for project
[info] com.timushev.sbt:sbt-updates : 0.3.0 -> 0.3.4 -> 0.4.3
[info] org.scala-lang:scala-library:provided : 2.10.6 -> 2.12.4
> reload return
```
Only plugins defined in a project are checked, there is currently no way to check updates for global plugins.
You can also check updates for dependencies and sbt plugins with:
```
sbt ";dependencyUpdates; reload plugins; dependencyUpdates"
```
Usage as project plugin
=======================
It is preferred to use sbt-updates as a global plugin. Nevertheless, there might be cases when you want to use sbt-updates
as a project plugin. In that case, add the plugin definition to `project/sbt-updates.sbt`. You can then use dependencyUpdates
target to find updates for your project. But this way you won't be able to check sbt plugin updates. In order to check both
dependency updates and sbt plugin updates, add the plugin to both project and meta project i.e `project/sbt-updates.sbt`
and `project/project/sbt-updates.sbt` and run:
```
sbt ";dependencyUpdates; reload plugins; dependencyUpdates; reload return"
```
Publishing
==========
`sbt-updates` relies on the repository Maven metadata. If you want to get update notifications
for artifacts published by other sbt projects, you should ensure that metadata is updated
correctly. One possible way to achieve this is to use [sbt-aether-deploy](https://github.com/arktekk/sbt-aether-deploy).
Example
=======
In order from left, the result shows current version, patch update version, minor update version and major update version.
```
> dependencyUpdates
[info] Found 3 dependency updates for test-project
[info] ch.qos.logback:logback-classic : 0.8 -> 0.8.1 -> 0.9.30 -> 1.0.13
[info] org.scala-lang:scala-library : 2.9.1 -> 2.9.3 -> 2.10.3
[info] org.slf4j:slf4j-api : 1.6.4 -> 1.6.6 -> 1.7.5
```