Convert deployment config to sample template#4
Merged
Conversation
- Rename config/deploy.yml to config/deploy.yml.example for templating - Add config/deploy.yml to .gitignore to prevent committing sensitive deployment settings - Update README.md installation instructions to include deployment config setup - Update project structure documentation to reflect sample file approach This allows users to customize their deployment settings without risk of committing sensitive server information or credentials to the repository.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Rename the deployment configuration file to a template and update documentation to guide users in setting up their own deployment settings while preventing the accidental commit of sensitive information.
This pull request updates the deployment instructions and configuration references in the
README.mdto clarify the use of deployment configuration templates for Kamal. The changes help ensure users copy and edit the correct files when setting up deployment.Documentation and configuration improvements:
README.mdto instruct users to copyconfig/deploy.yml.exampletoconfig/deploy.ymlbefore editing deployment settings. [1] [2]README.mdto listconfig/deploy.yml.exampleas the configuration template, making it clear which file should be edited for deployment.