End of Life

This gem lists GitHub repositories using end-of-life Ruby versions.

Installation

gem install end_of_life

Usage

1. Set up a GitHub access token (we recommend using a read-only token);

2. Export the GITHUB_TOKEN environment variable or set it when calling end_of_life;

3. Use the end_of_life command to list the repositories:

$ GITHUB_TOKEN=something end_of_life # if your platform supports symlinks, you can use the `eol` command instead
[✔] Fetching repositories...
[✔] Searching for EOL Ruby in repositories...

Found 2 repositories using EOL Ruby (<= 2.7.8):
┌───┬──────────────────────────────────────────────┬──────────────┐
│   │ Repository                                   │ Ruby version │
├───┼──────────────────────────────────────────────┼──────────────┤
│ 1 │ https://github.com/MatheusRich/my_rails_app  │ 2.5.8        │
│ 2 │ https://github.com/MatheusRich/some_repo     │ 2.5.0        │
└───┴──────────────────────────────────────────────┴──────────────┘

Options

There are some options to help you filter down the results:

Usage: end_of_life [options]
        --exclude=NAME,NAME2           Exclude repositories containing a certain word in its name. You can specify up to five words.
        --public-only                  Searches only public repostories
        --private-only                 Searches only private repostories
        --repo, --repository=USER/REPO Searches a specific repostory
        --org, --organization=ORG,ORG2 Searches within specific organizations
    -u, --user=NAME                    Sets the user used on the repository search
        --max-eol-days-away NUMBER     Sets the maximum number of days away a version can be from EOL. It defaults to 0.
        --include-archived             Includes archived repositories on the search
    -v, --version                      Displays end_of_life version
    -h, --help                         Displays this help

How it works

This gem fetches all your GitHub repositories that contain Ruby code, then searches for files that may have a Ruby version. Currently, those files are: .ruby-version, Gemfile, Gemfile.lock, and .tool-version. We parse these files and extract the minimum Ruby version used in the repository.

The EOL Ruby version is provided by https://endoflife.date/, with a file fallback.

IMPORTANT: To parse Gemfiles, we need to execute the code inside it. Be careful because this may be a security risk. We plan to add a secure parser for Gemfiles in the future.

Some other limitations are listed on the issues page.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/MatheusRich/end_of_life.

License

The gem is available as open source under the terms of the MIT License.