Скачать или смотреть How to Manage a Private and a Public GitHub Repository with Secrets

Discover how to maintain both private and public GitHub repositories while keeping sensitive files hidden with a simple automated solution.
---
This video is based on the question https://stackoverflow.com/q/67961781/ asked by the user 'Star' ( https://stackoverflow.com/u/14165115/ ) and on the answer https://stackoverflow.com/a/67962767/ provided by the user 'bk2204' ( https://stackoverflow.com/u/8705432/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: Is there a way to have a private and a public github repository and have a secret folder in the private one

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Managing Private and Public GitHub Repositories: How to Keep Secrets Safe

In today’s programming world, using GitHub for version control has become a standard practice. However, many developers often face the dilemma of needing to maintain both private and public repositories at the same time. This is particularly crucial when sensitive information must remain confidential, while still allowing contributions and visibility on the public side.

The Challenge
Your question might resonate with many: how do you keep a secret .py file in a private repo while allowing the public to access a different version of that file? Moreover, is there a way to automate the process so that you don't have to manually sync these files?

The Solution: Automate Your Secret Management

The good news is that you can have both a private and a public repository and manage your secrets efficiently. Here’s how you can set up your environment without having conflicting histories or manual syncing.

Step 1: Use a Template Approach

Create a Template File:

Begin by developing a reusable template file that contains non-secret parts of your code. This file can be structured to hold everything necessary for public contributions, except the confidential information.

Generate the Actual File:

Write a simple script that uses this template together with your secrets to generate the private .py file. By running this script, you can create a new file that incorporates sensitive information dynamically.

Step 2: Ignore Sensitive Files

Using the .gitignore File:

Ensure that both the generated file containing secrets and the original template file are listed in the .gitignore. This way, Git will not track changes to these files, providing the privacy needed for sensitive data.

Step 3: Include in Your Project Workflow

Automation Through Deployment:

Incorporate your generation script into the project deployment or bootstrap process. By doing this, every time your project is initialized or deployed, the script will automatically create the necessary secret file.

Best Practices for Managing Secrets

It's essential to understand that storing secrets directly in your repositories is not recommended. Accidental leaks can occur through various means, including:

Serving your .git directory over HTTP

Misconfigurations in your GitHub settings

Alternative to Repository Secrets

For production environments, consider using a specialized secret management system. Some popular options include:

HashiCorp Vault

GitHub Actions Secrets Store

Environment Variables

These approaches provide a higher level of security while allowing you to use the secrets during runtime in a safe manner.

Conclusion

Managing a private and a public GitHub repository effectively, while keeping sensitive information secure, is indeed possible. By adopting a templating approach and automating the file generation, you can significantly reduce the risk of accidental exposure of secrets. Always remember: the best practice is to keep your secrets out of your repository and use secure storage solutions when necessary.

Final Thoughts

With the right setup, you can focus on developing your projects without the worry of exposing sensitive data. Happy coding!