aboutsummaryrefslogtreecommitdiffstats
path: root/railties/lib/rails/commands/credentials/USAGE
diff options
context:
space:
mode:
Diffstat (limited to 'railties/lib/rails/commands/credentials/USAGE')
-rw-r--r--railties/lib/rails/commands/credentials/USAGE13
1 files changed, 7 insertions, 6 deletions
diff --git a/railties/lib/rails/commands/credentials/USAGE b/railties/lib/rails/commands/credentials/USAGE
index 0396fcb403..6b896ab02a 100644
--- a/railties/lib/rails/commands/credentials/USAGE
+++ b/railties/lib/rails/commands/credentials/USAGE
@@ -35,14 +35,15 @@ You could prepend that to your server's start command like this:
Rails provides `rails credentials:diff --enable` to instruct Git to call `rails credentials:diff`
when `git diff` is run on a credentials file.
-Any credentials files are set to use the "rails_credentials" diff driver in .gitattributes.
-Since Git requires the diff driver to be set up in a config file, the command uses
-the project local .git/config. Since that config isn't stored in Git each team member
-must enable separately.
+Running the command enrolls the project such that all credentials files use the
+"rails_credentials" diff driver in .gitattributes.
-Or set up the "rails_credentials" diff driver globally with:
+Additionally since Git requires the driver itself to be set up in a config file
+that isn't tracked Rails automatically ensures it's configured when running
+`credentials:edit`.
- git config --global diff.rails_credentials.textconv "bin/rails credentials:diff"
+Otherwise each co-worker would have to run enable manually, including on each new
+repo clone.
=== Editing Credentials