Readme — com.github.liquidz/antq 0.15.1

Antq

Point out your outdated dependencies.

Antq requires Clojure 1.8.0 or later. (However --upgrade option requires Clojure 1.9.0 or later)
If you’d like to use with 1.7.0 or earlier, please see here.

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).

In order to use it, add the following plugin to your project.clj (or $HOME/.lein/profiles.clj):

 :plugins [[com.github.liquidz/antq "RELEASE"]]
 ;; optional - you can add antq options here:
 :antq {}

Then, run lein antq.

GitHub Actions

Antq can work with GitHub Actions. See antq’s workflow for concrete example.

.github/workflows/dependencies.yml
To show errors as annotations, please set this option: --error-format="::error file={{file}}::{{message}}"

In another way, you can use the following action.

https://github.com/liquidz/antq-action

Options

--upgrade

Upgrade outdated versions interactively. You can use --force option for upgrading without confirmation.

For now, --upgrade option only supports following files.

deps.edn
shadow-cljs.edn
project.clj
build.boot
pom.xml

--exclude=ARTIFACT_NAME[@VERSION]

Skip version checking for specified artifacts or versions.

E.g.

# Exclude all versions of specified artifact
--exclude=com.github.liquidz/antq
# Exclude specific version of specified artifact
--exclude=com.github.liquidz/antq@0.13.0

When you specified a version number, antq will report the latest version excluding only the specified version.

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

You must specify groupId/artifactId for Java dependencies.

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

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: Clojars Verified Group Names policy.
`{{diff-url}}`	The diff URL for Version Control System. (Nullable)
`{{message}}`	Default error message.

{{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: Clojars Verified Group Names policy.

{{diff-url}}

The diff URL for Version Control System. (Nullable)

{{message}}

Default error message.

--reporter=REPORTER

Reporter Name Description

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.

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

clojure-dependency-update-action: A simple GitHub Actions to create Pull Requests for outdated tools.deps dependencies

License

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.

Antq

Supported files

Usage

Clojure CLI Tool

Leiningen (as a `main` program)

Leiningen (as a plugin)