How to keep public and private versions of a git repo in sync?

by

The simplest solution would be to have private branch in your ‘private’ repository, i.e. branch which is simply not pushed to public repository.

For that you would probably need to either specify all branches you want to push to public repository in config (instead of using globbing mirroring refspec +refs/*:refs/*), or push carefully branches you want to publish and rely on Git behaviour of pushing matching branches (those which are present on remote side) setting “push.default” to current default value “matching”.

If you by accident push your private branch, you can delete it in remote repository (unless it is configured to forbid this) using “git push <remote> :refs/heads/<private-branch>” (to remember this: push empty value to remote branch). You can protect against accidental pushing of your private branch using hooks on remote side, see e.g. update-paranoid example hook in contrib/examples.

Sidenote: Junio C Hamano, git maintainer, pushes to public git repositories only specified set of branches: ‘maint’, ‘master’, ‘next’, ‘pu’ (proposed updates), and ‘html’, ‘man’, ‘todo’; he does not publish short-lived often changing feature branches.

EXAMPLE SETUP:

    working repository  ---->  private repository (bare)  ---->  public repository  
    \------ private -------/     \------- protected ------------/     \------- public -----/

“Working repository” is the repository with working area that you make commits in, where you pull changes and resolve conflicts; repository where you do your work. Let’s say it contains the following branches: ‘public’ with changes that can be published to the world, ‘private’ that you want to not share with others or share only with selected subset of people, and perhaps some feature branches like ‘ticket-234’ or ‘add-frobnicator’, which are not ready even for selected group to see. This repository is non-bare, as it not published.

It would have something like the following configuration for pushing to ‘private’ repository. Note that “matching branches” behavior is set explicitely here, see git-pull manpage:

[remote "private"]
        url = [email protected]:/srv/private/git/repo.git
        push = +:

“Private repository” is public bare repository available only to selected people, for example it is available for fetching only via SSH. It has only branches which are ready, i.e. ‘public’ and ‘private’ branches; either those branches were present when creating “private” repository, or were pushed explicitely (“git push private <branch>“) from “working” repository. Push from “working” repository pushes (transfers) only matching branches, i.e. only ‘public’ and ‘private’ branches.

“Private repository” has post-update or post-receive hook set which pushes ‘public’ branch only to “public repository” (see below) if it was pushed to it (well, it can push unconditionally).

“Public repository” is public bare repository available to everyone, for example it is hosted on GitHub, and/or Gitorious, and/or repo.or.cz, or perhaps it is served via git:// protocol using git-daemon. It contains only ‘public’ branch, and it uses update or pre-receive either to accept whilelist of branches (here only ‘public’ branch is accepted), or reject blacklist of branches (in this example pushes to/creating ‘private’ branch would be rejected). It is updated automatically when pushing to “private” repository.

This setup might be overly complicated for your needs; “private” repository might be not necessary in your case. In such case the configuration in “working repository” for pushing directly to “public repository” would look like this:

[repository "public"]
        url = ssh://example.com/srv/git/repo.git
        push = refs/heads/public:refs/heads/public

I hope this example would help; please however read the documentation and do not use it blindly.

More Related Contents:

  1. Heroku upload-Precompiling assets failed
  2. What is the preferred way to manage schema.rb in git?
  3. Heroku – Display hash of current commit in browser
  4. SSL certificate rejected trying to access GitHub over HTTPS behind firewall
  5. Single table inheritance and where to use it in Rails
  6. Is there a way to get a collection of all the Models in your Rails app?
  7. No route matches “/users/sign_out” devise rails 3
  8. Is it possible to include a file in your .gitconfig
  9. Git – remote: Repository not found
  10. Disable ActiveRecord for Rails 4
  11. Creating a many to many relationship in Rails
  12. Paperclip exception : Paperclip::AdapterRegistry::NoHandlerError
  13. Rails 3: Get Random Record
  14. Setting session timeout in Rails 3
  15. Rails 4 link_to Destroy not working in Getting Started tutorial
  16. Merging between forks in GitHub
  17. In Ruby on Rails, what’s the difference between DateTime, Timestamp, Time and Date?
  18. Can I get the name of the current controller in the view?
  19. Rails 4 nested attributes and has_many :through associaton in a form
  20. How do I use RVM and create globally available gems?
  21. How do I add files and folders into GitHub repos?
  22. Difference between Render and Render Partial and Yield
  23. Setup sunspot solr with rails in production environment
  24. Push and pull my conda environment using git
  25. How do I ignore the authenticity token for specific actions in Rails?
  26. Git Clone – Repository not found
  27. Setting session length with Devise
  28. Template is missing
  29. git – remote add origin vs remote set-url origin
  30. git clone with HTTPS or SSH remote?

Leave a Comment