Skip to content

Automatically fetch latest ruby-build version with 24h cache #484

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
exterm wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Automatically fetch latest ruby-build version with 24h cache #484

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c27f94c
Automatically fetch latest ruby-build version with 24h cache
exterm Jan 14, 2026
fb77da0
Remove version cache
exterm Jan 14, 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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
ruby-build
ruby-build-source
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ RUBY_APPLY_PATCHES=$'dir/1.patch\n2.patch\nhttp://example.com/3.patch' asdf inst
RUBY_APPLY_PATCHES=$(curl -s https://raw.githubusercontent.com/rvm/rvm/master/patchsets/ruby/2.1.1/railsexpress) asdf install ruby 2.1.1
```

> [!NOTE]
> This plugin does not automatically fetch new Ruby versions. Running `asdf plugin update ruby` will update asdf-ruby and ensure the latest versions of Ruby are available to install. If the desired ruby version is still not showing up see the below [Troubleshooting](https://github.com/asdf-vm/asdf-ruby?tab=readme-ov-file#troubleshooting) section.
By default asdf-ruby automatically fetches the latest release of ruby-build, so new Ruby versions are available as soon as ruby-build supports them.

By default asdf-ruby uses a recent release of ruby-build, however instead you can choose your own branch/tag through the `ASDF_RUBY_BUILD_VERSION` variable:
You can pin to a specific ruby-build version/branch/tag with the `ASDF_RUBY_BUILD_VERSION` environment variable:

```
ASDF_RUBY_BUILD_VERSION=master asdf install ruby 2.6.4
ASDF_RUBY_BUILD_VERSION=v20240101 asdf install ruby 3.3.0
ASDF_RUBY_BUILD_VERSION=master asdf install ruby 3.3.0
```

## Default gems
Expand Down Expand Up @@ -68,7 +68,7 @@ note that you might have to change `.ruby-version` to include full version (e.g.
## Troubleshooting

> [!NOTE]
> The most common issue reported for this plugin is a missing Ruby version. If you are not seeing a recent Ruby version in the list of available Ruby versions it's likely due to having an older version of this plugin. Run `asdf plugin update ruby` to get the most recent list of Ruby versions. If it is still not showing up then this plugin's `RUBY_BUILD_VERSION` in lib/utils.sh likely needs updated with the latest ruby-build release https://github.com/rbenv/ruby-build/releases. Please check for an existing PR before submitting a new one. If there is not one, please fork the repo and submit one. If this plugin's ruby-build needs updated, you can workaround it with `ASDF_RUBY_BUILD_VERSION`. A note in the above [Use](https://github.com/asdf-vm/asdf-ruby?tab=readme-ov-file#use) section describes how to do this.
> If you are not seeing a recent Ruby version, check ruby-build's releases at https://github.com/rbenv/ruby-build/releases to see if it's been added yet.

If you are moving to asdf-ruby from another Ruby version manager, it is recommended to completely uninstall the old Ruby version manager before installing asdf-ruby.

Expand Down
75 changes: 63 additions & 12 deletions lib/utils.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
#!/usr/bin/env bash

RUBY_BUILD_VERSION="${ASDF_RUBY_BUILD_VERSION:-v20260114}"
RUBY_BUILD_TAG="$RUBY_BUILD_VERSION"

echoerr() {
echo >&2 -e "\033[0;31m$1\033[0m"
}
Expand All @@ -17,30 +14,39 @@ ensure_ruby_build_setup() {
}

ensure_ruby_build_installed() {
local current_ruby_build_version
local current_ruby_build_version target_version

target_version="$(get_ruby_build_version)"

if [ ! -f "$(ruby_build_path)" ]; then
download_ruby_build
else
# No ruby-build installed - we must have a version to download
if [ -z "$target_version" ]; then
errorexit "Could not determine ruby-build version. Check your network connection."
fi
download_ruby_build "$target_version"
elif [ -n "$target_version" ]; then
# ruby-build exists and we have a target version - check if update needed
current_ruby_build_version="$("$(ruby_build_path)" --version | cut -d ' ' -f2)"
# If ruby-build version does not start with 'v',
# add 'v' to beginning of version
# shellcheck disable=SC2086
if [ ${current_ruby_build_version:0:1} != "v" ]; then
current_ruby_build_version="v$current_ruby_build_version"
fi
if [ "$current_ruby_build_version" != "$RUBY_BUILD_VERSION" ]; then
if [ "$current_ruby_build_version" != "$target_version" ]; then
# If the ruby-build directory already exists and the version does not
# match, remove it and download the correct version
rm -rf "$(ruby_build_dir)"
download_ruby_build
download_ruby_build "$target_version"
fi
fi
# If ruby-build exists but we couldn't get a target version, just use what's installed
}

download_ruby_build() {
local version="$1"
# Print to stderr so asdf doesn't assume this string is a list of versions
echoerr "Downloading ruby-build..."
echoerr "Downloading ruby-build ${version}..."
# shellcheck disable=SC2155
local build_dir="$(ruby_build_source_dir)"

Expand All @@ -51,11 +57,13 @@ download_ruby_build() {
git clone https://github.com/rbenv/ruby-build.git "$build_dir" >/dev/null 2>&1
(
cd "$build_dir" || exit
git checkout "$RUBY_BUILD_TAG" >/dev/null 2>&1
git checkout "$version" >/dev/null 2>&1
)

# Install in the ruby-build dir
PREFIX="$(ruby_build_dir)" "$build_dir/install.sh"
# Install in the ruby-build dir (must use absolute path as install.sh changes directory)
local install_dir
install_dir="$(cd "$(asdf_ruby_plugin_path)" && pwd)/ruby-build"
PREFIX="$install_dir" "$build_dir/install.sh"

# Remove ruby-build source dir
rm -rf "$build_dir"
Expand All @@ -76,3 +84,46 @@ ruby_build_source_dir() {
ruby_build_path() {
echo "$(ruby_build_dir)/bin/ruby-build"
}

# Fetch the latest ruby-build version tag from GitHub
fetch_latest_ruby_build_version() {
git ls-remote --tags --sort=-version:refname https://github.com/rbenv/ruby-build.git 2>/dev/null |
grep -oE 'refs/tags/v[0-9]+$' |
head -1 |
sed 's|refs/tags/||'
}

# Get the ruby-build version to use
# Priority: ASDF_RUBY_BUILD_VERSION env var > fetched latest > installed version
get_ruby_build_version() {
# If user explicitly set a version, use that
if [ -n "${ASDF_RUBY_BUILD_VERSION:-}" ]; then
echo "$ASDF_RUBY_BUILD_VERSION"
return 0
fi

# Fetch latest version from GitHub
local latest_version
latest_version="$(fetch_latest_ruby_build_version)"

if [ -n "$latest_version" ]; then
echo "$latest_version"
return 0
fi

# Fallback: if ruby-build is already installed, use its version
# (if we can't reach GitHub, we likely can't download a new version anyway)
if [ -f "$(ruby_build_path)" ]; then
local installed_version
installed_version="$("$(ruby_build_path)" --version | cut -d ' ' -f2)"
if [ "${installed_version:0:1}" != "v" ]; then
installed_version="v$installed_version"
fi
echoerr "Warning: Could not fetch latest ruby-build version, using installed version ${installed_version}"
echo "$installed_version"
return 0
fi

# No version available
return 1
}