Add gitignores for rails credentials #23263
Merged
+17
−1
Conversation
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
|
Adding radjabov since #23254 was included on that branch. |
We're switching to rails credentials to keep current with rails 7.1 and the future. Note, we're assuming we won't want to commit and share encrypted credentials. If we want to share them, such as for recording cassettes, the comments describe how to switch to only ignoring the plain text encryption key files. Followup to: ManageIQ#23254 Required for: ManageIQ/manageiq-providers-autosde#253
jrafanie
force-pushed
the
rails-credentials-gitignores
branch
from
9439091
to
45d2578
Compare
Fryguy
reviewed
Nov 15, 2024
Comment on lines
+48
to
+60
| # See: EDITOR=vi be rails credentials:edit --help for more information | ||
| # Rails credentials follow the following pattern: | ||
| # If ENV['RAILS_MASTER_KEY'] isn't specified: | ||
| # Global is used: | ||
| # * config/master.key (plain text encryption key) | ||
| # * config/credentials.yml.enc (encrypted credentials file) | ||
| # If --environment test, the overrides for that environment is used: | ||
| # * config/credentials/test.key | ||
| # * test.yml.enc | ||
| # If we want to commit and share encrypted credentials, we can change the two lines below to: | ||
| # config/*.key | ||
| # config/credentials/*.key | ||
| config/credentials* |
There was a problem hiding this comment.
Is this the Rails boilerplate or is this something you wrote up? I'll merge regardless, I'm just curious.
There was a problem hiding this comment.
I added the comments.
Rails assumes you'll want to commit the yml.enc encrypted files and share your .key file so only the .key is .gitignored. When you do rails credentials:edit with environment or without, it only adds the .gitignore for that particular .key file. I think it's safer to ignore both key and encrypted file for now and if we ever want to use a shared encrypted credentials file by sharing the key, we can remove the encrypted credentials file from the .gitignore.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We're switching to rails credentials to keep current with rails 7.1 and the future. Note, we're assuming we won't want to commit and share encrypted credentials. If we want to share them, such as for recording cassettes, the comments describe how to switch to only ignoring the plain text encryption key files.
Followup to: #23254
Required for: ManageIQ/manageiq-providers-autosde#253