Skip to content

fix(install): put ant on PATH from install.sh, as install.ps1 does (#194) #223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Nic-dorman wants to merge 7 commits into
base: main
Choose a base branch
from
Open

fix(install): put ant on PATH from install.sh, as install.ps1 does (#194) #223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
bc5c465
fix(install): put ant on PATH from install.sh, as install.ps1 does (#…
Nic-dorman Oct 12, 2026
e4aaa87
fix(install): name Apache Ant in the shadowing note; check PATH in ma…
Nic-dorman Oct 12, 2026
3211965
fix(install): escape INSTALL_DIR in startup lines; clear CDPATH for a…
Nic-dorman Oct 27, 2026
c8feea5
fix(install): refuse to put a directory with shell syntax in its name…
Nic-dorman Oct 27, 2026
e1648ce
fix(install): refuse a colon in INSTALL_DIR for PATH, reject a newlin…
Nic-dorman Oct 27, 2026
65a1f87
fix(install): reject a newline in the effective install path, not jus…
Nic-dorman Oct 28, 2026
12ed4d6
Merge main and move the changelog entry into [Unreleased]
Nic-dorman Oct 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
223 changes: 223 additions & 0 deletions .github/workflows/install-test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ jobs:
env:
ANT_VERSION: ${{ inputs.version }}
INSTALL_DIR: ${{ runner.temp }}/bin
ANT_NO_MODIFY_PATH: "1"
run: bash install.sh

- name: verify binary
Expand All @@ -37,6 +38,149 @@ jobs:
echo "Bootstrap config installed at $config_file"
cat "$config_file"

# A default install must leave `ant` on PATH in new shells with no manual edit (#194). env -i
# starts each shell from a PATH without ~/.local/bin, as on a fresh machine.
- name: verify a default install is on PATH in new shells
env:
ANT_VERSION: ${{ inputs.version }}
run: |
fresh() { env -i HOME="$HOME" SHELL=/bin/bash PATH=/usr/bin:/bin "$@"; }
fresh ANT_VERSION="$ANT_VERSION" bash install.sh
for shell in "bash -lc" "bash -ic"; do
# shellcheck disable=SC2086 # $shell is a shell and its flag, split on purpose.
found="$(fresh $shell 'command -v ant' 2> /dev/null || true)"
echo "$shell: ${found:-<not found>}"
[ "$found" = "$HOME/.local/bin/ant" ] || exit 1
done
fresh bash -lc 'ant --version'

# Shells can run part of a PATH entry containing $, `, " or \ as code (macOS login shells
# re-read PATH through path_helper unescaped), so the installer must leave such a directory
# out of every startup file, and the line it prints instead must be safe to paste. zsh and
# fish are installed so their startup files are checked too. sh is dash.
- name: verify an install directory with shell syntax in its name is refused
env:
ANT_VERSION: ${{ inputs.version }}
run: |
sudo apt-get update -qq && sudo apt-get install -y -qq zsh fish > /dev/null
home="$RUNNER_TEMP/odd-home"
mkdir -p "$home"
fresh() { env -i HOME="$home" SHELL=/bin/bash PATH=/usr/bin:/bin "$@"; }
# shellcheck disable=SC2016 # The syntax is meant to reach the installer unexpanded.
dir="$home"'/odd $(touch $HOME/ran-subst) `touch $HOME/ran-backtick` "quoted" back\slash'
out="$(fresh ANT_VERSION="$ANT_VERSION" INSTALL_DIR="$dir" bash install.sh)"
echo "$out"
if ! echo "$out" | grep -q "was not added to your shell startup files"; then
echo "ERROR: expected the installer to refuse this directory"
exit 1
fi
for f in .profile .bashrc .zshenv .config/fish/conf.d/ant.fish; do
if [ -e "$home/$f" ]; then
echo "ERROR: $f was written"
exit 1
fi
done
line="$(echo "$out" | grep -m1 '^ export PATH=')"
found="$(env -i HOME="$home" PATH=/usr/bin:/bin sh -c "$line; command -v ant" || true)"
echo "printed line: ${found:-<not found>}"
[ "$found" = "$dir/ant" ] || exit 1
if ls "$home"/ran-* 2> /dev/null; then
echo "ERROR: code from the install directory's name ran"
exit 1
fi

# Every other character is safe inside the double quotes of the lines written, so a name with
# spaces, quotes and other punctuation must still be added and resolve in each new shell.
- name: verify an install directory with other punctuation in its name is added
env:
ANT_VERSION: ${{ inputs.version }}
run: |
home="$RUNNER_TEMP/punct-home"
mkdir -p "$home"
fresh() { env -i HOME="$home" SHELL=/bin/bash PATH=/usr/bin:/bin "$@"; }
dir="$home/my apps (x86) & 'quoted' #1 *"
fresh ANT_VERSION="$ANT_VERSION" INSTALL_DIR="$dir" bash install.sh
for shell in "bash -lc" "bash -ic" "sh -lc" "zsh -c" "fish -c"; do
# shellcheck disable=SC2086 # $shell is a shell and its flag, split on purpose.
found="$(fresh $shell 'command -v ant' 2> /dev/null || true)"
echo "$shell: ${found:-<not found>}"
[ "$found" = "$dir/ant" ] || exit 1
done

# PATH is colon-separated, so a name with `:` can't be a PATH entry at all: no startup file,
# fish's included, and no `export PATH=` line, with or without --no-modify-path. A newline is
# rejected before anything is installed, whether it is in INSTALL_DIR or, for a relative one,
# in the current directory; `pwd` would strip a trailing one, and the install would land in
# the directory without it.
- name: verify an install directory with a colon or a newline in its name is refused
env:
ANT_VERSION: ${{ inputs.version }}
run: |
installer="$PWD/install.sh"
home="$RUNNER_TEMP/colon-home"
mkdir -p "$home"
fresh() { env -i HOME="$home" SHELL=/bin/bash PATH=/usr/bin:/bin "$@"; }
for case in "$home/with:colon|" "$home/trailing:|" "$home/no-modify:path|1"; do
dir="${case%|*}"
out="$(fresh ANT_VERSION="$ANT_VERSION" INSTALL_DIR="$dir" ANT_NO_MODIFY_PATH="${case##*|}" bash install.sh)"
echo "$out"
if ! echo "$out" | grep -q "can't be added to your PATH"; then
echo "ERROR: expected the installer to refuse $dir"
exit 1
fi
if echo "$out" | grep -q '^ export PATH='; then
echo "ERROR: the installer printed an export line for $dir"
exit 1
fi
done
for f in .profile .bashrc .zshenv .config/fish/conf.d/ant.fish; do
if [ -e "$home/$f" ]; then
echo "ERROR: $f was written"
exit 1
fi
done
mkdir -p "$home/nl"
if fresh ANT_VERSION="$ANT_VERSION" INSTALL_DIR="$home/nl"$'\n' bash install.sh; then
echo "ERROR: an INSTALL_DIR ending in a newline was accepted"
exit 1
fi
if [ -e "$home/nl/ant" ] || [ -e "$home/nl"$'\n' ]; then
echo "ERROR: something was installed for an INSTALL_DIR ending in a newline"
exit 1
fi
# A relative INSTALL_DIR from a current directory whose name ends in a newline, with the
# directory without it present, and from one with a newline in the middle.
mkdir -p "$home/work" "$home/work"$'\n' "$home/a"$'\n'"b"
for cwd_dir in "$home/work"$'\n'"|." "$home/a"$'\n'"b|bin"; do
cwd="${cwd_dir%|*}"
if (cd "$cwd" && fresh ANT_VERSION="$ANT_VERSION" INSTALL_DIR="${cwd_dir##*|}" bash "$installer"); then
echo "ERROR: a relative INSTALL_DIR under a directory with a newline in its name was accepted"
exit 1
fi
done
if [ -e "$home/work/ant" ] || [ -e "$home/work"$'\n'"/ant" ] || [ -e "$home/a"$'\n'"b/bin" ]; then
echo "ERROR: something was installed for a current directory with a newline in its name"
exit 1
fi

# A relative INSTALL_DIR is made absolute with `cd`, which also prints the directory when it
# is found through CDPATH.
- name: verify a relative install directory with CDPATH set
env:
ANT_VERSION: ${{ inputs.version }}
run: |
work="$RUNNER_TEMP/relative"
mkdir -p "$work"
cp install.sh "$work/"
cd "$work"
out="$(CDPATH=. INSTALL_DIR=bin ANT_NO_MODIFY_PATH=1 bash install.sh)"
echo "$out"
if ! echo "$out" | grep -qxF "Installed ant to $work/bin/ant"; then
echo "ERROR: expected ant to be installed to $work/bin/ant"
exit 1
fi
"$work/bin/ant" --version

test-install-script-macos:
name: test install.sh (macOS)
runs-on: macos-latest
Expand All @@ -47,6 +191,7 @@ jobs:
env:
ANT_VERSION: ${{ inputs.version }}
INSTALL_DIR: ${{ runner.temp }}/bin
ANT_NO_MODIFY_PATH: "1"
run: bash install.sh

- name: verify binary
Expand All @@ -65,6 +210,84 @@ jobs:
echo "Bootstrap config installed at $config_file"
cat "$config_file"

# As on Linux (#194), from a fresh-machine PATH. /bin/bash is the 3.2 that `curl | bash` runs
# on a stock Mac, and zsh is the default login shell. zsh login shells run /etc/zprofile's
# path_helper and Homebrew's shellenv after ~/.zshenv, which put ~/.local/bin behind
# /opt/homebrew/bin, where this runner image has Apache Ant (also `ant`). So login shells are
# checked for ~/.local/bin on PATH rather than for which `ant` wins.
- name: verify a default install is on PATH in new shells
env:
ANT_VERSION: ${{ inputs.version }}
run: |
fresh() { env -i HOME="$HOME" SHELL=/bin/zsh PATH=/usr/bin:/bin "$@"; }
fresh ANT_VERSION="$ANT_VERSION" /bin/bash install.sh
found="$(fresh zsh -c 'command -v ant' || true)"
echo "zsh -c: ${found:-<not found>}"
[ "$found" = "$HOME/.local/bin/ant" ]
for shell in "zsh -lc" "zsh -ic" "/bin/bash -lc"; do
# shellcheck disable=SC2016,SC2086 # $PATH is for the new shell; $shell is split on purpose.
p="$(fresh $shell 'echo $PATH' 2> /dev/null || true)"
echo "$shell: $p"
case ":$p:" in *":$HOME/.local/bin:"*) ;; *) exit 1 ;; esac
done
fresh zsh -c 'ant --version'

# As on Linux, a name with shell syntax in it is refused and runs nothing, here with the stock
# /bin/bash running the installer and macOS's own sed. Login shells run path_helper, which is
# why such a name can't be put on PATH here at all.
- name: verify an install directory with shell syntax in its name is refused
env:
ANT_VERSION: ${{ inputs.version }}
run: |
home="$RUNNER_TEMP/odd-home"
mkdir -p "$home"
fresh() { env -i HOME="$home" SHELL=/bin/zsh PATH=/usr/bin:/bin "$@"; }
# shellcheck disable=SC2016 # The syntax is meant to reach the installer unexpanded.
dir="$home"'/odd $(touch $HOME/ran-subst) `touch $HOME/ran-backtick` "quoted" back\slash'
out="$(fresh ANT_VERSION="$ANT_VERSION" INSTALL_DIR="$dir" /bin/bash install.sh)"
echo "$out"
if ! echo "$out" | grep -q "was not added to your shell startup files"; then
echo "ERROR: expected the installer to refuse this directory"
exit 1
fi
for f in .profile .bash_profile .zshenv; do
if [ -e "$home/$f" ]; then
echo "ERROR: $f was written"
exit 1
fi
done
fresh zsh -lc true
fresh /bin/bash -lc true
line="$(echo "$out" | grep -m1 '^ export PATH=')"
found="$(env -i HOME="$home" PATH=/usr/bin:/bin /bin/sh -c "$line; command -v ant" || true)"
echo "printed line: ${found:-<not found>}"
[ "$found" = "$dir/ant" ] || exit 1
if ls "$home"/ran-* 2> /dev/null; then
echo "ERROR: code from the install directory's name ran"
exit 1
fi

# A name with spaces, quotes and other punctuation must still be added, and come through
# path_helper intact in login shells.
- name: verify an install directory with other punctuation in its name is added
env:
ANT_VERSION: ${{ inputs.version }}
run: |
home="$RUNNER_TEMP/punct-home"
mkdir -p "$home"
fresh() { env -i HOME="$home" SHELL=/bin/zsh PATH=/usr/bin:/bin "$@"; }
dir="$home/my apps (x86) & 'quoted' #1 *"
fresh ANT_VERSION="$ANT_VERSION" INSTALL_DIR="$dir" /bin/bash install.sh
found="$(fresh zsh -c 'command -v ant' || true)"
echo "zsh -c: ${found:-<not found>}"
[ "$found" = "$dir/ant" ] || exit 1
for shell in "zsh -lc" "zsh -ic" "/bin/bash -lc"; do
# shellcheck disable=SC2016,SC2086 # $PATH is for the new shell; $shell is split on purpose.
p="$(fresh $shell 'printf "%s\n" "$PATH"' 2> /dev/null || true)"
echo "$shell: $p"
case ":$p:" in *":$dir:"*) ;; *) exit 1 ;; esac
done

test-install-script-windows:
name: test install.ps1 (Windows)
runs-on: windows-latest
Expand Down
18 changes: 18 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Changed
- `install.sh` puts `ant` on `PATH`, as `install.ps1` already did on Windows, so `ant --version`
works in a new terminal straight after installing (#194). When `INSTALL_DIR` is not already on
`PATH` it adds a guarded line to `~/.profile`, to the user's existing bash startup files, to
`~/.zshenv` when zsh is installed and to fish's `conf.d` when fish is, and lists each file it
changed. A directory whose name contains `$`, a backtick, `"` or `\` is not added, because
shells can run part of such a PATH entry as code (macOS login shells re-read `PATH` through
`path_helper` without escaping it). The installer says so and prints an escaped line for the
current shell instead. A name with `:`, which separates `PATH` entries, can't be added at all,
and an install directory containing a newline (in `INSTALL_DIR`, or in the current directory
for a relative one) is rejected before anything is installed.
`--no-modify-path` or `ANT_NO_MODIFY_PATH=1` (also honoured by `install.ps1`) restores
the old print-the-line behaviour. The macOS default install directory moves from
`/usr/local/bin`, which is root-owned without Homebrew so the install failed without `sudo`, to
`~/.local/bin`, matching Linux. If another `ant` is already on `PATH` — an earlier macOS
install in `/usr/local/bin`, or an unrelated program such as Apache Ant — the installer says
so, since it may shadow the new one.

## [0.3.12] - 2026-10-22

### Changed (breaking — `ant-core` browser API)
Expand Down
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,15 @@ Both installers take the same environment variables:
|----------|-------------|
| `ANT_CHANNEL` | Release channel: `stable` (default) or `beta`. See [Beta Programme](#beta-programme). |
| `ANT_VERSION` | Install one specific version, e.g. `0.3.3`. Overrides `ANT_CHANNEL`. |
| `INSTALL_DIR` | Where to put the binary. Defaults to `~/.local/bin` on Linux, `/usr/local/bin` on macOS, `%LOCALAPPDATA%\ant\bin` on Windows. |
| `INSTALL_DIR` | Where to put the binary. Defaults to `~/.local/bin` on Linux and macOS, `%LOCALAPPDATA%\ant\bin` on Windows. |
| `ANT_NO_MODIFY_PATH` | Set to `1` to stop the installer adding `INSTALL_DIR` to your `PATH`. |

If `INSTALL_DIR` is not already on your `PATH`, the installer adds it, so `ant` works in every new
terminal. `install.ps1` adds it to your Windows user `PATH`. `install.sh` adds one guarded line to
`~/.profile`, to whichever of `~/.bash_profile`, `~/.bash_login` and `~/.bashrc` you already have,
to `~/.zshenv` when zsh is installed and to `conf.d/ant.fish` when fish is, and lists each file it
changed. To leave your startup files alone, pass `--no-modify-path` (`curl ... | bash -s --
--no-modify-path`) or set `ANT_NO_MODIFY_PATH=1`.

### npm

Expand Down
17 changes: 13 additions & 4 deletions install.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
# ANT_CHANNEL - release channel to install from: "stable" (default) or "beta".
# ANT_VERSION - install a specific version (e.g. "0.1.1"). Overrides ANT_CHANNEL.
# INSTALL_DIR - override install directory (default: %LOCALAPPDATA%\ant\bin).
# ANT_NO_MODIFY_PATH - set to 1 to leave your user PATH alone; the installer prints the
# directory to add instead.
#
# Examples:
# irm <this-script> | iex # newest stable
Expand Down Expand Up @@ -199,12 +201,19 @@ try {

# Add to user PATH if not already there
$UserPath = [Environment]::GetEnvironmentVariable("Path", "User")
$ModifyPath = (-not $env:ANT_NO_MODIFY_PATH) -or ($env:ANT_NO_MODIFY_PATH -eq "0")
if ($UserPath -notlike "*$InstallDir*") {
Say ""
Say "Adding $InstallDir to your user PATH..."
[Environment]::SetEnvironmentVariable("Path", "$InstallDir;$UserPath", "User")
$env:Path = "$InstallDir;$env:Path"
Say "Restart your terminal for the PATH change to take effect."
if ($ModifyPath) {
Say "Adding $InstallDir to your user PATH..."
[Environment]::SetEnvironmentVariable("Path", "$InstallDir;$UserPath", "User")
$env:Path = "$InstallDir;$env:Path"
Say "Restart your terminal for the PATH change to take effect."
} else {
Say "WARNING: $InstallDir is not in your user PATH."
Say "Add it for this session with:"
Say " `$env:Path = `"$InstallDir;`$env:Path`""
}
}
} finally {
Remove-Item -Path $TempDir -Recurse -Force -ErrorAction SilentlyContinue
Expand Down
Loading
Loading