Point out your outdated dependencies.
= 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/antq.svg["Clojars Project", link="https://clojars.org/antq"] image:https://img.shields.io/badge/docker-automated-blue["Docker Hub", link="https://hub.docker.com/r/uochan/antq"]
Antq requires Clojure 1.8.0 or later. (However
--upgradeoption requires Clojure 1.9.0 or later) +
== Supported files
== Usage
=== Clojure CLI Tool
Run the following command for trial.
Or add the following alias to your
$HOME/.clojure/deps.edn.
{ :aliases {:outdated {:extra-deps {antq/antq {:mvn/version "RELEASE"}} :main-opts ["-m" "antq.core"]}}
Then, run
clojure -M:outdated. (run
clojure -A:outdatedfor Clojure CLI Tool 1.10.1.645 or earlier).
=== Leiningen
Add the following dependency and alias to your
$HOME/.lein/profiles.clj.
{ :user {:dependencies [[antq/antq "RELEASE"]] :aliases {"outdated" ["run" "-m" "antq.core"]} }
Then, run
lein outdated.
=== 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.
== Options === --upgrade Upgrade outdated versions interactively. You can use
--forceoption for upgrading without confirmation.
For now,
--upgradeoption only supports following files.
=== --exclude=ARTIFACT_NAME Skip version checking for specified artifacts.
E.g.
--exclude=antq/antq
NOTE: You must specify
groupId/artifactIdfor Java dependencies.
=== --directory=DIRECTORY Add search path for projects. Current directory(
.) is added by default.
E.g.
-d foo --directory=bar:bazwill search "foo", "baz" and "bar" directories.
=== --focus=ARTIFACT_NAME
Focus version checking for specified artifacts.
E.g.
--focus=antq/antq
NOTE: You must specify
groupId/artifactIdfor Java dependencies.
WARNING:
focusoption is prefer than
excludeoption.
=== --skip=PROJECT_TYPE Skip to search specified project files. Must be one of
boot,
clojure-cli,
github-action,
pom,
shadow-cljsand
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.
|
{{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-formatoption, this reporter will be used automatically.
|
json| Report results as a JSON format.
|
edn| Report results as a EDN format.
|===
== 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.