diff options
author | Hiroshi SHIBATA <hsbt@ruby-lang.org> | 2021-06-14 12:54:37 +0900 |
---|---|---|
committer | nagachika <nagachika@ruby-lang.org> | 2021-07-07 10:03:15 +0900 |
commit | dd28c03d5fd7a82d1b694a9c2332a55dab81add9 (patch) | |
tree | c19c73eaebe30b9d2e00a31de362723fb9c78da7 /lib/bundler/man/bundle-config.1.ronn | |
parent | 3e2f089432119cf67017d55f4deef2ea909ceb79 (diff) |
Merge RubyGems-3.2.17 and Bundler-2.2.17
Diffstat (limited to 'lib/bundler/man/bundle-config.1.ronn')
-rw-r--r-- | lib/bundler/man/bundle-config.1.ronn | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/lib/bundler/man/bundle-config.1.ronn b/lib/bundler/man/bundle-config.1.ronn index ba4bd5ff23..15bc5af778 100644 --- a/lib/bundler/man/bundle-config.1.ronn +++ b/lib/bundler/man/bundle-config.1.ronn @@ -196,7 +196,7 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html). Defaults to `true` when `--deployment` is used. * `gem.github_username` (`BUNDLE_GEM__GITHUB_USERNAME`): Sets a GitHub username or organization to be used in `README` file when you - create a new gem via `bundle gem` command. It can be overriden by passing an + create a new gem via `bundle gem` command. It can be overridden by passing an explicit `--github-username` flag to `bundle gem`. * `gem.push_key` (`BUNDLE_GEM__PUSH_KEY`): Sets the `--key` parameter for `gem push` when using the `rake release` @@ -376,6 +376,23 @@ where you can use personal OAuth tokens: export BUNDLE_GITHUB__COM=abcd0123generatedtoken:x-oauth-basic +Note that any configured credentials will be redacted by informative commands +such as `bundle config list` or `bundle config get`, unless you use the +`--parseable` flag. This is to avoid unintentially leaking credentials when +copy-pasting bundler output. + +Also note that to guarantee a sane mapping between valid environment variable +names and valid host names, bundler makes the following transformations: + +* Any `-` characters in a host name are mapped to a triple dash (`___`) in the + corresponding enviroment variable. + +* Any `.` characters in a host name are mapped to a double dash (`__`) in the + corresponding environment variable. + +This means that if you have a gem server named `my.gem-host.com`, you'll need to +use the `BUNDLE_MY__GEM___HOST__COM` variable to configure credentials for it +through ENV. ## CONFIGURE BUNDLER DIRECTORIES |