Skip to content
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.

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

Clarify BUNDLE_USER_CONFIG is a file #7668

Merged
merged 1 commit into from
May 28, 2024
Merged

Conversation

dkav
Copy link
Contributor

@dkav dkav commented May 16, 2024

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

Documentation is not explicit that BUNDLE_USER_CONFIG sets a file not a directory.

I assumed that BUNDLE_USER_CONFIG was a path to where the config file was to be saved. But I found out that if export BUNDLE_USER_CONFIG=$XDG_CONFIG_HOME/bundle is defined in my profile Bundler will create a file called bundle in the $XDG_CONFIG_HOME folder.

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

A slight modification to the relevant documentation. More could be added if deemed necessary.

Make sure the following tasks are checked

Copy link

welcome bot commented May 16, 2024

Thanks for opening a pull request and helping make RubyGems and Bundler better! Someone from the RubyGems team will take a look at your pull request shortly and leave any feedback. Please make sure that your pull request has tests for any changes or added functionality.

We use GitHub Actions to test and make sure your change works functionally and uses acceptable conventions, you can review the current progress of GitHub Actions in the PR status window below.

If you have any questions or concerns that you wish to ask, feel free to leave a comment in this PR or join our #rubygems or #bundler channel on Slack.

For more information about contributing to the RubyGems project feel free to review our CONTRIBUTING guide

Copy link
Member

@deivid-rodriguez deivid-rodriguez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thanks!

@deivid-rodriguez
Copy link
Member

You need to run bin/rake man:build and commit the result so that the man page is also updated.

@dkav
Copy link
Contributor Author

dkav commented May 16, 2024

Ok. The change was made on GitHub but I cloned, ran the script and amended the commit with the updated man page.

Copy link
Member

@deivid-rodriguez deivid-rodriguez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you so much!

@deivid-rodriguez deivid-rodriguez merged commit 242162c into rubygems:master May 28, 2024
83 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants