repo-showcase

To keep a GitHub repository private while showcasing architecture publicly, you can use a dual repository pattern. It maintains a secure private codebase and a public showcase repository, using GitHub Actions to automatically synchronize only the architecture documentation.

Automated documentation synchronization works by using the GitHub CLI to establish a connection. GitHub Actions then intercepts documentation updates in the private repository and automatically pushes them to the public mirror, keeping the public showcase updated without manual intervention.

Yes, you need a GitHub Personal Access Token to automate repository mirroring. The token is required for inter-repository operations, allowing the GitHub CLI to authenticate and securely push documentation updates from the private codebase to the public showcase.

The best way to automate creating a public mirror repository is to use a proactive setup pattern. When initiating a new project, a script automatically creates both the private code repository and the public showcase repository, establishing a secure synchronization pipeline immediately.

Yes, you can use GitHub Actions to separate sensitive code from public developer portfolios. The automation ensures proprietary logic remains protected in a private repository while maintaining a public-facing record of the project's structure and architectural overviews.

You should avoid using a dual repository pattern if your project does not contain sensitive client logic or proprietary code. It is specifically designed for scenarios where secure private code must remain protected while architectural overviews are made publicly accessible.