Skip to content
This repository has been archived by the owner on Apr 14, 2021. It is now read-only.

Document the order Bundler loads settings #6464

Merged
merged 1 commit into from
Mar 28, 2018
Merged

Conversation

rubymorillo
Copy link
Contributor

@rubymorillo rubymorillo commented Mar 28, 2018

Parsed out the information in the first graph in order to help users understand the order of priority Bundler follows when loading config settings.

Thanks so much for the contribution!
To make reviewing this PR a bit easier, please fill out answers to the following questions.

What was the end-user problem that led to this PR?

The problem was...
...confusion from end users about the order that Bundler loads settings in.

Before:

This command allows you to interact with bundler's configuration system.
Bundler retrieves its configuration from the local application (`app/.bundle/config`),
environment variables, and the user's home directory (`~/.bundle/config`),
in that order of priority.

What was your diagnosis of the problem?

My diagnosis was...
...Colby pointed out how the bundle-config doc needed to be updated to reflect this. After reviewing the bundle-config doc, it appears there was some information about how Bundler loads config settings, but it wasn't complete and as apparent to users. So I decided to separate the graph out and document the settings as a list so users could spot that easier.

What is your fix for the problem, implemented in this PR?

My fix...
...was to verify the order of priority of settings and write them out as a list.

After:

This command allows you to interact with Bundler's configuration system.

Bundler loads configuration settings in this order:

1. Local config (`app/.bundle/config`)
2. Environmental variables (`ENV`)
3. Global config (`~/.bundle/config`)
4. Bundler default config

Why did you choose this fix out of the possible options?

I chose this fix because...
it was clear that the document had to be updated, and lists are easier for readability.

fixes #6334

Parsed out the information in the first graph in order to help users understand the order of priority Bundler follows when loading config settings.
@colby-swandale
Copy link
Member

Great! @bundlerbot r+

@bundlerbot
Copy link
Collaborator

📌 Commit f0b4b1e has been approved by colby-swandale

@bundlerbot
Copy link
Collaborator

⌛ Testing commit f0b4b1e with merge 8b8b963...

bundlerbot added a commit that referenced this pull request Mar 28, 2018
Document the order Bundler loads settings

Parsed out the information in the first graph in order to help users understand the order of priority Bundler follows when loading config settings.

Thanks so much for the contribution!
To make reviewing this PR a bit easier, please fill out answers to the following questions.

### What was the end-user problem that led to this PR?

The problem was...
...[confusion from end users](#6270) about the order that Bundler loads settings in.

Before:
```
This command allows you to interact with bundler's configuration system.
Bundler retrieves its configuration from the local application (`app/.bundle/config`),
environment variables, and the user's home directory (`~/.bundle/config`),
in that order of priority.
```

### What was your diagnosis of the problem?

My diagnosis was...
...[Colby pointed out how the bundle-config doc](#6334) needed to be updated to reflect this. After reviewing the `bundle-config` doc, it appears there was some information about how Bundler loads config settings, but it wasn't complete and as apparent to users. So I decided to separate the graph out and document the settings as a list so users could spot that easier.

### What is your fix for the problem, implemented in this PR?

My fix...
...was to verify the order of priority of settings and write them out as a list.

After:
```
This command allows you to interact with Bundler's configuration system.

Bundler loads configuration settings in this order:

1. Local config (`app/.bundle/config`)
2. Environmental variables (`ENV`)
3. Global config (`~/.bundle/config`)
4. Bundler default config
```

### Why did you choose this fix out of the possible options?

I chose this fix because...
it was clear that the document had to be updated, and lists are easier for readability.

fixes #6334
@bundlerbot
Copy link
Collaborator

☀️ Test successful - status-travis
Approved by: colby-swandale
Pushing 8b8b963 to master...

@bundlerbot bundlerbot merged commit f0b4b1e into master Mar 28, 2018
@colby-swandale colby-swandale deleted the rubymorillo-patch-3 branch March 29, 2018 00:30
@colby-swandale colby-swandale added this to the 1.16.2 milestone Apr 4, 2018
colby-swandale pushed a commit that referenced this pull request Apr 11, 2018
Document the order Bundler loads settings

Parsed out the information in the first graph in order to help users understand the order of priority Bundler follows when loading config settings.

Thanks so much for the contribution!
To make reviewing this PR a bit easier, please fill out answers to the following questions.

### What was the end-user problem that led to this PR?

The problem was...
...[confusion from end users](#6270) about the order that Bundler loads settings in.

Before:
```
This command allows you to interact with bundler's configuration system.
Bundler retrieves its configuration from the local application (`app/.bundle/config`),
environment variables, and the user's home directory (`~/.bundle/config`),
in that order of priority.
```

### What was your diagnosis of the problem?

My diagnosis was...
...[Colby pointed out how the bundle-config doc](#6334) needed to be updated to reflect this. After reviewing the `bundle-config` doc, it appears there was some information about how Bundler loads config settings, but it wasn't complete and as apparent to users. So I decided to separate the graph out and document the settings as a list so users could spot that easier.

### What is your fix for the problem, implemented in this PR?

My fix...
...was to verify the order of priority of settings and write them out as a list.

After:
```
This command allows you to interact with Bundler's configuration system.

Bundler loads configuration settings in this order:

1. Local config (`app/.bundle/config`)
2. Environmental variables (`ENV`)
3. Global config (`~/.bundle/config`)
4. Bundler default config
```

### Why did you choose this fix out of the possible options?

I chose this fix because...
it was clear that the document had to be updated, and lists are easier for readability.

fixes #6334

(cherry picked from commit 8b8b963)
colby-swandale pushed a commit that referenced this pull request Apr 20, 2018
Document the order Bundler loads settings

Parsed out the information in the first graph in order to help users understand the order of priority Bundler follows when loading config settings.

Thanks so much for the contribution!
To make reviewing this PR a bit easier, please fill out answers to the following questions.

### What was the end-user problem that led to this PR?

The problem was...
...[confusion from end users](#6270) about the order that Bundler loads settings in.

Before:
```
This command allows you to interact with bundler's configuration system.
Bundler retrieves its configuration from the local application (`app/.bundle/config`),
environment variables, and the user's home directory (`~/.bundle/config`),
in that order of priority.
```

### What was your diagnosis of the problem?

My diagnosis was...
...[Colby pointed out how the bundle-config doc](#6334) needed to be updated to reflect this. After reviewing the `bundle-config` doc, it appears there was some information about how Bundler loads config settings, but it wasn't complete and as apparent to users. So I decided to separate the graph out and document the settings as a list so users could spot that easier.

### What is your fix for the problem, implemented in this PR?

My fix...
...was to verify the order of priority of settings and write them out as a list.

After:
```
This command allows you to interact with Bundler's configuration system.

Bundler loads configuration settings in this order:

1. Local config (`app/.bundle/config`)
2. Environmental variables (`ENV`)
3. Global config (`~/.bundle/config`)
4. Bundler default config
```

### Why did you choose this fix out of the possible options?

I chose this fix because...
it was clear that the document had to be updated, and lists are easier for readability.

fixes #6334

(cherry picked from commit 8b8b963)
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document the order that Bundler loads settings
3 participants