Skip to content

Add installation option with aqua to README - #920

Open
tadayosi wants to merge 6 commits into
apache:masterfrom
tadayosi:install-aqua
Open

Add installation option with aqua to README#920
tadayosi wants to merge 6 commits into
apache:masterfrom
tadayosi:install-aqua

Conversation

@tadayosi

@tadayosi tadayosi commented Mar 2, 2024

Copy link
Copy Markdown
Member

Aqua is a new CLI version manager. It works really cool.

I added an installation method using aqua.

@gnodet @ppalaga Please check it.

@slachiewicz slachiewicz added the documentation Improvements or additions to documentation label Mar 17, 2024
elharo
elharo previously requested changes Sep 17, 2025
Comment thread README.adoc Outdated
Comment thread README.adoc Outdated

[source,shell]
----
$ aqua g -i apache/maven-mvnd

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried the above command and it gave me:

> aqua g -i apache/maven-mvnd
FATA[0000] aqua failed                                   env=darwin/arm64 error=configuration file isn't found program=aqua program_version=2.55.2

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess you just first need to run aqua init to have aqua.yaml in your home directory.
https://aquaproj.github.io/docs/tutorial

@gnodet gnodet left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documentation-only change adding aqua as an installation method — the aqua registry does support maven-mvnd, so this is a valid addition.

Two issues to address before merging:

  1. $ prompt prefix (medium): The $ aqua g -i apache/maven-mvnd command re-introduces the $ prompt prefix that commit 31a212a deliberately removed from all install commands to prevent copy-paste errors (zsh: command not found: $). All other install blocks (SDKMAN, Homebrew, MacPorts) are consistent without it.

  2. Missing prerequisite note (low): The aqua g -i command fails with FATA[0000] configuration file isn't found if aqua init has not been run first. Other install sections include contextual notes (SDKMAN mentions ~/.m2/mvnd.properties, Homebrew explains the two formulae). A brief mention or link to the aqua getting started guide would help users avoid this error.

This review was generated by an AI agent and may contain inaccuracies. Please verify all suggestions before applying.

Claude Code on behalf of gnodet

Comment thread README.adoc Outdated
@elharo
elharo dismissed their stale review July 28, 2026 11:30

done

@gnodet gnodet left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documentation-only PR adding aqua as an installation option — the package exists in the aqua registry and the section placement is appropriate.

One minor consistency issue: the shell command includes a $ prompt prefix that was deliberately removed from all other installation commands in commit 31a212a ("chore: make install commands copy+pastable") to prevent zsh: command not found: $ errors when users copy the command verbatim. The $ should be removed for consistency with the SDKMAN, Homebrew, and MacPorts commands.

This review was generated by an AI agent and may contain inaccuracies. Please verify all suggestions before applying.

Claude Code on behalf of gnodet

Comment thread README.adoc Outdated
slachiewicz and others added 2 commits August 1, 2026 17:17
Co-authored-by: Guillaume Nodet <gnodet@gmail.com>
Co-authored-by: Guillaume Nodet <gnodet@gmail.com>

@gnodet gnodet left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re-review after new commits: the $ prompt prefix was correctly removed (commit f2ea1ad ✅), but commit b1ed4fe introduced a broken AsciiDoc source block — the opening ---- delimiter was accidentally replaced with a duplicate of the command.

Current (broken):

[source,shell]
aqua g -i apache/maven-mvnd
aqua g -i apache/maven-mvnd
----

Expected:

[source,shell]
----
aqua g -i apache/maven-mvnd
----

This looks like a mis-applied GitHub suggestion that targeted the wrong line. The fix is to restore the opening ---- delimiter and remove the duplicated command line.

This review was generated by an AI agent and may contain inaccuracies. Please verify all suggestions before applying.

Claude Code on behalf of @gnodet

Comment thread README.adoc
=== Install using https://aquaproj.github.io/[aqua]

[source,shell]
aqua g -i apache/maven-mvnd

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The opening ---- delimiter is missing and the command is duplicated. This block should be:

[source,shell]
----
aqua g -i apache/maven-mvnd
----

It looks like the GitHub suggestion from the previous review was applied to the wrong line (the delimiter instead of the command), which replaced ---- with the command text.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants