Скачать или смотреть Can You Create a Private Folder in a Public Repository on GitHub?

Discover if it’s possible to have a private folder within a public GitHub repository and learn about alternative methods to achieve your goal.
---
This video is based on the question https://stackoverflow.com/q/70830031/ asked by the user 'Mikolaj' ( https://stackoverflow.com/u/16108057/ ) and on the answer https://stackoverflow.com/a/70830148/ provided by the user 'Kangkan Rajkhowa' ( https://stackoverflow.com/u/7758137/ ) 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: Private folder in public repository

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.
---
Can You Create a Private Folder in a Public Repository on GitHub?

In the world of software development and collaborative projects, GitHub serves as an essential tool for version control and code sharing. However, many users find themselves grappling with an important question: Can I create a private folder within a public repository? This question arises for a number of reasons, including the desire to store sensitive information or personal project details that you want to keep hidden from the public eye. In this post, we will explore the limitations of GitHub in this regard and discuss potential workarounds.

The Issue at Hand

The core of the problem lies in GitHub’s repository structure. GitHub operates on a clear public/private dichotomy for repositories, meaning that a repository can either be completely public, accessible to anyone, or completely private, restricted to those you invite. Unfortunately, this binary choice extends to folder structures within those repositories.

What Are the Implications?

Public repositories: Anyone can view, clone, and contribute to these repositories. All content is visible.

Private repositories: Only selected collaborators can access the content. This is ideal for sensitive or proprietary information.

The Challenge

When users wish to maintain a public repository for collaboration while also having a section that remains hidden, it can lead to complications. Storing sensitive data in a public repository poses significant risks, including unintentional data leaks or security vulnerabilities.

The Solution: Separate Repositories

So, what can you do when you need the functionality of a public repository but also require a place for your private files? Unfortunately, the direct answer is:

You Cannot Mix Public and Private Settings Within One Repository.

However, here's a workaround that could meet your needs:

Create Separate Repositories:

Create two repositories: one public for the collaborative aspects of your project and another private for any sensitive information.

Use Git Submodules:

To unify your workflow, you can utilize Git submodules to link your public project repository to your private repository.

This method allows you to keep the core of your public project intact while maintaining a boundary around your sensitive data.

How to Use Git Submodules

Here’s a simplified breakdown of managing submodules:

Step 1: Create your public and private repositories on GitHub.

Step 2: In your public repository, run the command to add your private repository as a submodule:

[[See Video to Reveal this Text or Code Snippet]]

Step 3: Commit the changes and push them to your public repository. Now, your public repo contains a link to your private folder, but the content remains secure and hidden from public view.

Important Considerations

Workflow Complexity: Maintaining two repositories can complicate your workflow; ensure that your team is on board with this structure.

Access Permissions: Remember that anyone with access to the public repository can see the reference to the private repository but will not have access to its contents.

Conclusion

In summary, while it is not possible to create a private folder within a public repository on GitHub, employing separate repositories with submodules can effectively allow you to manage public collaboration while safeguarding sensitive information. Planning and organization remain key to ensuring a smooth workflow. By considering these strategies, you can protect your data without sacrificing the collaborative advantages that GitHub provides.

Feel free to share your experiences or questions in the comments below, as we navigate the complexities of repository management together!