Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/olical/depot
Find newer versions of your dependencies in your deps.edn file
https://github.com/olical/depot
clojure
Last synced: 3 days ago
JSON representation
Find newer versions of your dependencies in your deps.edn file
- Host: GitHub
- URL: https://github.com/olical/depot
- Owner: Olical
- License: unlicense
- Created: 2018-03-21T22:34:14.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2021-05-01T14:59:15.000Z (almost 4 years ago)
- Last Synced: 2025-01-29T16:57:17.490Z (3 days ago)
- Topics: clojure
- Language: Clojure
- Homepage: https://clojars.org/olical/depot
- Size: 224 KB
- Stars: 260
- Watchers: 8
- Forks: 14
- Open Issues: 4
-
Metadata Files:
- Readme: README-v1.md
- Changelog: CHANGES.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Depot [](https://clojars.org/olical/depot)
Find newer versions of your dependencies in your `deps.edn` file using the [Clojure CLI][cli]. This works for maven _and_ git dependencies.
## Usage
You can try it out easily with this one liner:
```bash
$ clojure -Sdeps '{:deps {olical/depot {:mvn/version "1.8.4"}}}' -m depot.outdated.main
| Dependency | Current | Latest |
|---------------------|---------|--------|
| org.clojure/clojure | 1.9.0 | 1.10.0 |
```
I'd recommend adding depot as an alias in your own `deps.edn` file, this will allow it to check itself for updates:
> Note: Replace the ellipsis with the current version shown above.
```clojure
{:deps {}
:aliases {:outdated {:extra-deps {olical/depot {:mvn/version "..."}}
:main-opts ["-m" "depot.outdated.main"]}}}
```
```bash
$ clojure -Aoutdated -a outdated
| Dependency | Current | Latest |
|--------------|---------|--------|
| olical/depot | ..... | ..... |
```
### Updating `deps.edn`
To automatically update the versions in `deps.edn`, use `--update`.
```bash
$ clojure -m depot.outdated.main --update
Updating: deps.edn
rewrite-clj {:mvn/version "0.6.0"} -> {:mvn/version "0.6.1"}
cider/cider-nrepl {:mvn/version "0.17.0"} -> {:mvn/version "0.18.0"}
clj-time {:mvn/version "0.14.4"} -> {:mvn/version "0.15.1"}
olical/cljs-test-runner {:sha "5a18d41648d5c3a64632b5fec07734d32cca7671"} -> {:sha "da9710b389782d4637ef114176f6e741225e16f0"}
```
This will leave any formatting, whitespace, and comments intact. It will update
both the top level deps and any `:aliases` / `:extra-deps`. To prevent Depot
from touching certain parts of your `deps.edn`, mark them with the
`^:depot/ignore` metadata.
``` clojure
{:deps {...}
:aliases
{;; used for testing against older versions of Clojure
:clojure-1.8 ^:depot/ignore {:extra-deps
{org.clojure/clojure {:mvn/version "1.8.0"}}}
:clojure-1.9 ^:depot/ignore {:extra-deps
{org.clojure/clojure {:mvn/version "1.9.0"}}}}}
```
`--update` by default looks for `deps.edn` in the current working directory. You
can instead pass one or more filenames in explicitly.
``` bash
$ clojure -m depot.outdated.main --update ../my-project/deps.edn
```
## Freezing snapshots
Maven has a concept called "virtual" versions, these are similar to Git branches, they are pointers to another version, and the version they point to can change over time. The best known example are snapshot releases. When your `deps.edn` refers to a version `0.4.1-SNAPSHOT`, the version that actually gets installed will look like `0.4.1-20190222.154954-1`.
A maintainer can publish as many snapshots as they like, all with the same version string. This means that re-running the same code twice might yield different results, if in the meanwhile a new snapshot was released. So installing `0.4.1-SNAPSHOT` again later on may install a completely different version.
For the sake of stability and reproducibility it may be desirable to "lock" this version. This is what the `--resolve-virtual` flag is for. The `--resolve-virtual` flag will replace the snapshot version with the current timestamped version that the SNAPSHOT is an alias of, so that your code is once again deterministic.
Besides `SNAPSHOT` versions `--resolve-virtual` will also handle the special version strings `"RELEASE"` and `"LATEST"`
```
% clojure -Sdeps '{:deps {olical/depot {:local/root "/home/arne/github/depot"}}}' -m depot.outdated.main --resolve-virtual
Resolving: deps.edn
cider/piggieback 0.4.1-SNAPSHOT --> 0.4.1-20190222.154954-1
```
## Existing work
This project is inspired by [lein-ancient][], it relies on [version-clj][] (by the same author, [xsc][]) for parsing and comparison of version numbers.
## Contributors
* [@Olical](https://github.com/Olical) - Initial work and general maintenance.
* [@daaku](https://github.com/daaku) - Ensuring `:override-deps` is adhered to in the non-mutating mode.
* [@kennyjwilli](https://github.com/kennyjwilli) - Git dependency support and table improvements.
* [@lverns](https://github.com/lverns) - Reducing the runtime significantly by making multiple requests in parallel.
* [@plexus](https://github.com/plexus) - Both the `--update` and `--resolve-virtual` systems, so many improvements!
* [@robert-stuttaford](https://github.com/robert-stuttaford) - Presenting results in a neat table.
* [@seancorfield](https://github.com/seancorfield) - Support for `:override-deps`.
* [@dharrigan](https://github.com/dharrigan) - Bump dependencies, fixing warnings.
## Unlicenced
Find the full [unlicense][] in the `UNLICENSE` file, but here's a snippet.
>This is free and unencumbered software released into the public domain.
>
>Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
Do what you want. Learn as much as you can. Unlicense more software.
[unlicense]: http://unlicense.org/
[lein-ancient]: https://github.com/xsc/lein-ancient
[version-clj]: https://github.com/xsc/version-clj
[xsc]: https://github.com/xsc
[cli]: https://clojure.org/guides/deps_and_cli