rbenv Files

Hi, it's been a long time! 👋 The theme for this release is user-friendliness: both the initial rbenv init setup and the documentation throughout the project should be clearer and easier to understand, especially for newcomers.

Feature Changes

• The rbenv init command now modifies shell initialization files instead of printing instructions by @mislav in https://github.com/rbenv/rbenv/pull/1568

This solves one of the most common pitfalls rbenv users were experiencing: many did not understand that rbenv init only printed instructions intended for humans but did not change anything in their shell environment. Now, rbenv init actually modifies the environment, which seems to be what most users expected in the first place.

• rbenv init in setup mode defaults to no auto-rehashing by @mislav in https://github.com/rbenv/rbenv/pull/1579

• Init script automatically adds rbenv to PATH if necessary by @mislav in https://github.com/rbenv/rbenv/pull/1432

• Simplify resolving symlinks, remove native bash extension by @mislav in https://github.com/rbenv/rbenv/pull/1428

This solves a GPL license compliance issue where a GPL-licensed script was distributed with this project, which was not compatible with this project's license (MIT). https://github.com/rbenv/rbenv/issues/1395

• Support GEM_HOME by @mislav in https://github.com/rbenv/rbenv/pull/1436
• Add man page for rbenv by @mislav in https://github.com/rbenv/rbenv/pull/1438

Preview the man page in HTML form here: https://rbenv.org/man/rbenv.1

Fixes

• Simplify .ruby-version file read by @scop in https://github.com/rbenv/rbenv/pull/1393
• Ignore shell builtins and functions when looking up commands in PATH by @mislav in https://github.com/rbenv/rbenv/pull/1448
• Use the newer “compsys” completion system for zsh completions by @Farid-NL in https://github.com/rbenv/rbenv/pull/1569
• Ensure zsh user's prior shell options don't interfere with indexing into an array of arguments by @richiethomas in https://github.com/rbenv/rbenv/pull/1422
• rbenv shell: properly declare global variables for zsh by @mislav in https://github.com/rbenv/rbenv/pull/1566
• Support ksh versions by @kpschoedel in https://github.com/rbenv/rbenv/pull/1504

Documentation Improvements

• Massive README overhaul by @mislav in https://github.com/rbenv/rbenv/pull/1433
• Update code block in readme for rbenv-doctor script by @audreee in https://github.com/rbenv/rbenv/pull/1353
• Make bash commands copy-able by GitHub by @simonschaufi in https://github.com/rbenv/rbenv/pull/1360
• README: grammar fix by @dmerejkowsky in https://github.com/rbenv/rbenv/pull/1379
• Redirect Debian/Ubuntu users to install using git by @tommyjanna in https://github.com/rbenv/rbenv/pull/1388
• Fix link to Pow because the server is down by @uraitakahito in https://github.com/rbenv/rbenv/pull/1418
• Use absolute path in rbenv init instructions if needed by @mislav in https://github.com/rbenv/rbenv/pull/1434
• Consistent syntax in man page by @mislav in https://github.com/rbenv/rbenv/pull/1453
• Make the usage syntax for arbitrary args consistent by @mislav in https://github.com/rbenv/rbenv/pull/1447
• Improve disabling instruction by @ahangarha in https://github.com/rbenv/rbenv/pull/1468
• version-file docs update by @richiethomas in https://github.com/rbenv/rbenv/pull/1512
• help: have --usage always print a usage line by @mislav in https://github.com/rbenv/rbenv/pull/1515
• Update alerts in README by @dipree in https://github.com/rbenv/rbenv/pull/1537
• Clarify help text of some commands by @mislav in https://github.com/rbenv/rbenv/pull/1567
• Update link to maintained version of Bats by @acook in https://github.com/rbenv/rbenv/pull/1544
• Removes redundant ruby-build from brew-install by @jasonkarns in https://github.com/rbenv/rbenv/pull/1575

Housekeeping

• Use test -aP instead of which -a in test helper by @scop in https://github.com/rbenv/rbenv/pull/1359
• Add Shell linter - Differential-ShellCheck by @jamacku in https://github.com/rbenv/rbenv/pull/1419
• Followup to “Simplify resolving symlinks” feature:
• Switch back to resolving symlinks for rbenv executable by @mislav in https://github.com/rbenv/rbenv/pull/1439
• Test for executables but not functions by @mislav in https://github.com/rbenv/rbenv/pull/1440
• Avoid assuming rbenv original project layout by @mislav in https://github.com/rbenv/rbenv/pull/1449
• Fix resolving rbenv symlink to its final location by @mislav in https://github.com/rbenv/rbenv/pull/1482
• Restore Rubygems warning for user-installed gems by @mislav in https://github.com/rbenv/rbenv/pull/1445
• Use read -a to split output into an array by @mislav in https://github.com/rbenv/rbenv/pull/1450
• rbenv version- test coverage for preferring local over global version file by @richiethomas in https://github.com/rbenv/rbenv/pull/1456
• Update actions/checkout version to v3 by @ydah in https://github.com/rbenv/rbenv/pull/1461
• ci(lint): pin differential-shellcheck to v3 tag by @jamacku in https://github.com/rbenv/rbenv/pull/1465
• Added dependabot update for GitHub Actions by @hsbt in https://github.com/rbenv/rbenv/pull/1476
• Bump mislav/bump-homebrew-formula-action from 1.4 to 2.2 by @dependabot in https://github.com/rbenv/rbenv/pull/1477
• Bump redhat-plumbers-in-action/differential-shellcheck from 3 to 4 by @dependabot in https://github.com/rbenv/rbenv/pull/1478
• Add spec to cover inclusion of etc/ sub-folders in plugins test by @richiethomas in https://github.com/rbenv/rbenv/pull/1492
• ci: trigger differential-shellcheck workflow on push by @jamacku in https://github.com/rbenv/rbenv/pull/1497
• Fix a dead link in a comment by @notEthan in https://github.com/rbenv/rbenv/pull/1505
• Bump actions/checkout from 3 to 4 by @dependabot in https://github.com/rbenv/rbenv/pull/1521
• Bump mislav/bump-homebrew-formula-action from 2.2 to 2.3 by @dependabot in https://github.com/rbenv/rbenv/pull/1526
• Bump mislav/bump-homebrew-formula-action from 2.3 to 3.0 by @dependabot in https://github.com/rbenv/rbenv/pull/1530
• Bump mislav/bump-homebrew-formula-action from 3.0 to 3.1 by @dependabot in https://github.com/rbenv/rbenv/pull/1531
• Bump redhat-plumbers-in-action/differential-shellcheck from 4 to 5 by @dependabot in https://github.com/rbenv/rbenv/pull/1533
• Move gem-rehash monkey patch by @benmelz in https://github.com/rbenv/rbenv/pull/1541
• Use bats-core instead of archived version by @hsbt in https://github.com/rbenv/rbenv/pull/1545

New Contributors

• @audreee made their first contribution in https://github.com/rbenv/rbenv/pull/1353
• @simonschaufi made their first contribution in https://github.com/rbenv/rbenv/pull/1360
• @dmerejkowsky made their first contribution in https://github.com/rbenv/rbenv/pull/1379
• @tommyjanna made their first contribution in https://github.com/rbenv/rbenv/pull/1388
• @uraitakahito made their first contribution in https://github.com/rbenv/rbenv/pull/1418
• @richiethomas made their first contribution in https://github.com/rbenv/rbenv/pull/1422
• @jamacku made their first contribution in https://github.com/rbenv/rbenv/pull/1419
• @ydah made their first contribution in https://github.com/rbenv/rbenv/pull/1461
• @ahangarha made their first contribution in https://github.com/rbenv/rbenv/pull/1468
• @hsbt made their first contribution in https://github.com/rbenv/rbenv/pull/1476
• @dependabot made their first contribution in https://github.com/rbenv/rbenv/pull/1477
• @notEthan made their first contribution in https://github.com/rbenv/rbenv/pull/1505
• @kpschoedel made their first contribution in https://github.com/rbenv/rbenv/pull/1504
• @dipree made their first contribution in https://github.com/rbenv/rbenv/pull/1537
• @benmelz made their first contribution in https://github.com/rbenv/rbenv/pull/1541
• @acook made their first contribution in https://github.com/rbenv/rbenv/pull/1544
• @Farid-NL made their first contribution in https://github.com/rbenv/rbenv/pull/1569

Full Changelog: https://github.com/rbenv/rbenv/compare/v1.2.0...v1.3.0