-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: improve Ruby documentation (#7991)
Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
- Loading branch information
1 parent
303449a
commit 93bf122
Showing
1 changed file
with
11 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,29 +1,21 @@ | ||
| --- | ||
| title: Ruby Bundler Support | ||
| title: Ruby Bundler support | ||
| description: Ruby Bundler support in Renovate | ||
| --- | ||
|
|
||
| # Automated Dependency Updates for Ruby Bundler Dependencies | ||
| # Automated dependency updates for Ruby Bundler dependencies | ||
|
|
||
| Renovate supports upgrading dependencies in Bundler's `Gemfile`s and their accompanying `Gemfile.lock` files. | ||
| Support is considered "alpha" stage until there have been some more real-world tests. | ||
| Renovate supports upgrading dependencies in Bundler's Gemfiles and their accompanying `Gemfile.lock` files. | ||
|
|
||
| ## How It Works | ||
| ## How it works | ||
|
|
||
| 1. Renovate will search each repository for any `Gemfile` files | ||
| 2. Existing dependencies will be extracted from the files | ||
| 3. Renovate will resolve the dependency on Rubygems or elsewhere if configured, and look for any newer versions | ||
| 4. A PR will be created with `Gemfile` and `Gemfile.lock` updated in the same commit | ||
| 5. If the source repository has either a "changelog" file or uses GitHub releases, then Release Notes for each version will be embedded in the generated PR | ||
| 1. Renovate searches in each repository for any Gemfiles | ||
| 1. Existing dependencies are extracted from the Gemfiles | ||
| 1. Renovate resolves the dependency on Rubygems.org (or elsewhere if configured), and checks for newer versions | ||
| 1. A PR is created which updates the `Gemfile` and `Gemfile.lock` in a single commit | ||
| 1. If the source repository has a "changelog" file or uses GitHub releases, then Release Notes for each version are embedded in the generated PR | ||
|
|
||
| ## Enabling | ||
|
|
||
| Either install the [Renovate App](https://github.com/apps/renovate) on GitHub, or check out [Renovate OSS](https://github.com/renovatebot/renovate) for self-hosted. | ||
| Bundler support is now enabled by default in both. | ||
|
|
||
| ## Future work | ||
|
|
||
| - Updating `.gemspec` files | ||
| - Pinning dependencies to the version found in `Gemfile.lock` rather than the latest matching version | ||
| - Lock file maintenance | ||
| - Selective lock file updating (if ranges are in use in the `Gemfile`) | ||
| You can install the [Renovate App](https://github.com/apps/renovate) on GitHub. | ||
| Or you can check out [Renovate OSS](https://github.com/renovatebot/renovate) to self-host Renovate. |