= Antq
Point out your outdated dependencies.
image:https://github.com/liquidz/antq/workflows/test/badge.svg["GitHub Actions for test workflow", link="https://github.com/liquidz/antq/actions?query=workflow%3Atest"] image:https://github.com/liquidz/antq/workflows/lint/badge.svg["GitHub Actions for lint workflow", link="https://github.com/liquidz/antq/actions?query=workflow%3Alint"] image:https://github.com/liquidz/antq/workflows/dependencies/badge.svg["GitHub Actions for dependencies workflow", link="https://github.com/liquidz/antq/actions?query=workflow%3Adependencies"] image:https://codecov.io/gh/liquidz/antq/branch/master/graph/badge.svg["codecov", link="https://codecov.io/gh/liquidz/antq"]
image:https://img.shields.io/clojars/v/com.github.liquidz/antq["Clojars Project", link="https://clojars.org/com.github.liquidz/antq"] image:https://img.shields.io/badge/docker-automated-blue["GitHub Container Registry", link="https://github.com/users/liquidz/packages/container/package/antq"]
--upgrade option requires Clojure 1.9.0 or later) +
If you'd like to use with 1.7.0 or earlier, please see link:./doc/clojure-1.7.adoc[here].== Supported files
|=== | File | Tool/Service | Note
| deps.edn | https://clojure.org/guides/deps_and_cli[Clojure CLI] |
| shadow-cljs.edn | http://shadow-cljs.org[Shadow-cljs] |
| project.clj | https://leiningen.org[Leiningen] | Provides 2 ways of program and plug-in.
| build.boot | https://boot-clj.com[Boot] |
| pom.xml | https://maven.apache.org[Maven] |
| .github/workflows/*.yml | https://github.com/features/actions[GitHub Actions] |
| bb.edn | https://book.babashka.org/index.html#_bb_edn[Babashka] |
| build.gradle
| https://gradle.org[Gradle]
| Experimental. gradle command must be installed.
|===
== Usage
=== Clojure CLI Tool
$HOME/.clojure/deps.edn.
[source,clojure]Then, run clojure -M:outdated.
(run clojure -A:outdated for Clojure CLI Tool 1.10.1.645 or earlier).
=== Leiningen (as a main program)
$HOME/.lein/profiles.clj.
[source,clojure]Then, run lein outdated.
=== Leiningen (as a plugin)
The Leiningen plugin is a newer offering. It tends to be more accurate (since it won't parse your project.clj, having it evaluated by Leiningen instead).
However the :upgrade option will not be supported (since the plugin cannot always know if a given dependency came from a specific profile, middleware, etc).
project.clj (or $HOME/.lein/profiles.clj):
[source,clojure]Then, run lein antq.
=== GitHub Actions
Antq can work with https://github.com/features/actions[GitHub Actions]. See antq's workflow for concrete example.
--error-format="::error file={{file}}::{{message}}"In another way, you can use the following action.
=== Gradle
Antq experimentally supports https://gradle.org[Gradle]. See link:./doc/gradle.adoc[here] for details.
== Options
=== --upgrade
Upgrade outdated versions interactively.
You can use --force option for upgrading without confirmation.
For now, --upgrade option only supports following files.
=== --exclude=ARTIFACT_NAME[@VERSION] Skip version checking for specified artifacts or versions.
--exclude=com.github.liquidz/antq
When you specified a version number, antq will report the latest version excluding only the specified version.
NOTE: You must specify groupId/artifactId for Java dependencies.
=== --directory=DIRECTORY
Add search path for projects.
Current directory(.) is added by default.
E.g. -d foo --directory=bar:baz will search "foo", "baz" and "bar" directories.
=== --focus=ARTIFACT_NAME
Focus version checking for specified artifacts.
E.g. --focus=com.github.liquidz/antq
NOTE: You must specify groupId/artifactId for Java dependencies.
WARNING: focus option is prefer than exclude option.
=== --skip=PROJECT_TYPE
Skip to search specified project files.
Must be one of boot, clojure-cli, github-action, pom, shadow-cljs and leiningen.
E.g. --skip=pom
=== --error-format=ERROR_FORMAT Customize outputs for outdated dependencies.
E.g. --error-format="::error file={{file}}::{{message}}"
You can use following variables:
|=== | Variable Name | Description
| {{file}}
| A filename containing outdated dependencies.
| {{name}}
| The artifact name.
| {{version}}
| The current version.
| {{latest-version}}
| The latest version.
| {{latest-name}}
| The latest artifact name.
See details: https://github.com/clojars/clojars-web/wiki/Verified-Group-Names[Clojars Verified Group Names policy].
| {{diff-url}}
| The diff URL for Version Control System. (Nullable)
| {{message}}
| Default error message.
|===
=== --reporter=REPORTER
|=== | Reporter Name | Description
| table (default)
| Report results in a table.
| format
| Report results with a custom format.
When you use --error-format option, this reporter will be used automatically.
| json
| Report results as a JSON format.
| edn
| Report results as a EDN format.
|===
== Projects using antq
== Tips
== License
Copyright © 2020-2021 https://twitter.com/uochan[Masashi Iizuka]
This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at http://www.eclipse.org/legal/epl-2.0.
This Source Code may also be made available under the following Secondary Licenses when the conditions for such availability set forth in the Eclipse Public License, v. 2.0 are satisfied: GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version, with the GNU Classpath Exception which is available at https://www.gnu.org/software/classpath/license.html.
Content type
Image
Digest
Size
311.3 MB
Last updated
about 5 years ago
docker pull uochan/antq