SubGit

Space shortcuts

Page tree

Versions Compared

Old Version 4

changes.mady.by.user Ildar Khusainov

Saved on

compared with

New Version Current

changes.mady.by.user Dmitry Linov

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

SVN to GitHub mirror using SubGit

At the moment SubGit requires file-level access to Git repository which is not feasible with repositories hosted on GitHub. However, due to distributed nature of Git, one can establish reliable two-way mirror between SVN and SubGit-managed Git repository and then synchronize that Git repository with GitHub.

  1. Configure GitHub

    • login to GitHub and create new repository:

    Create new GitHub projectImage Removed

  2. Configure local server (the machine where Git repository will reside)

    • install Java Runtime environment:

      • for MacOS X download an appropriate JavaRE pack from the web site:

        https://java.com/en/download

        double click on the *.dmg file, once mounted open the application and follow the installation wizard.

      • for RedHat family Linux:

        $ sudo yum install java

      • for Debian-based Linux:

        $ sudo apt-get install default-jre

      install SubGit binary:

      • On non-Debian Linux and MacOS X download universal subgit-3.2.4.zip binary:

        https://subgit.com/download/subgit-3.2.4.zip and unzip it:

        • for Linux:

          $ unzip subgit-3.2.4.zip

        • on MacOS X it should be unpacked automatically (if downloaded with Safari), but if it isn't - double-click on the subgit-3.2.4.zip.

        on Debian family Linux (Debian/Ubuntu/Mint): download Debian package:

        https://subgit.com/download/subgit3.2.4all.deb

        fetch missing dependencies and install:

        $ sudo dpkg -i subgit3.2.4all.deb $ sudo apt-get install -f

      install Git to the local server:

      • on RHEL famylie Linux: $ yum install git

      • on Debian family Linux: $ apt-get install git

      • on MacOS X just try to run the tool in terminal: $ git if development tools weren't isntalled yet, this command will start installation wizard.

  3. Configure local repository

  4. Run this command on behalf of the same user you use to serve Git repository:

    $ subgit-3.2.4/bin/subgit configure --layout auto --trunk trunk SVNURL GITREPO > To be added into pop-up cloud (when hovering on SVNURL and GITREPO): > > SVN_URL - URL to the SVN project. > > GIT_REPO - path to new Git repository where data from the SVN project will be imported to. see command example --> (to be placed in drop-down block): $ subgit-3.2.4/bin/subgit configure --layout auto --trunk trunk http://example.com/svn/repository/project ./repo.git

    SubGit version 3.2.4 ('Bobique') build #3670

    Configuring writable Git mirror of remote Subversion repository: Subversion repository URL : http://example.com/svn/repository/project Git repository location : ./repo.git

    Detecting peg location... Authentication realm: http://example.com:80 Subversion Repository Username [user]: user Password [user]: Peg location detected: r10248 project/trunk Fetching SVN history... Done. Growing trees... Done. Project origin detected: r1 project/trunk Building branches layouts... Done. Combing beards... Done. Generating SVN to Git mapping... Done.

    CONFIGURATION SUCCESSFUL

    To complete SubGit installation do the following:

    1) Adjust Subversion to Git branches mapping if necessary: /home/user/repo.git/subgit/config 2) Define at least one Subversion credentials in default SubGit passwd file at: /home/user/repo.git/subgit/passwd OR configure SSH or SSL credentials in the [auth] section of: /home/user/repo.git/subgit/config 3) Optionally, add custom authors mapping to the authors.txt file(s) at: /home/user/repo.git/subgit/authors.txt 4) Run SubGit 'install' command: subgit install ./repo.git For complete subgit configure reference see Import book

    5. Enable post-receive hook: $ git config -f GITREPO/subgit/config svn.triggerSvnPostReceive true > **To be added into pop-up cloud (when hovering on GITREPO): > > GIT_REPO** - path to Install SubGit tool according to the Installation guide.

  5. Configure GitHub

    • Log in to GitHub and create a new repository:

      Image Added

     
  6. Configure the local repository:

    Run the command below on behalf of the same user you use to serve Git repository:

    No Format
    $ subgit configure --layout auto --trunk TRUNK SVN_URL GIT_REPO

    where

    • SVN_URL   – URL to the SVN project.
    • GIT_REPO  – a path to the new Git repository where data from the SVN project will be imported to.

    • TRUNK     – a path, relative to SVN_URL, that leads to an SVN directory that plays the role of the main line of development.
       

      Expand
      titlesee the configuration command example.


      Code Block
      languagetext
      themeFadeToGrey
      titlesubgit configure example
      $ subgit configure --layout auto --trunk trunk http://svn.example.com/svn/repository/project /home/user/project.git

            SubGit version 3.2.4 ('Bobique') build #3670

            Configuring writable Git mirror of remote Subversion repository:
                Subversion repository URL : http://svn.example.com/svn/repository/project
                Git repository location   : ./project.git

            Git repository is served by GitLab, hooks will be installed into 'custom_hooks' directory.

            Detecting peg location...
            Authentication realm: <http://svn.example.com/:80> Subversion Repository
            Username [git]: user
            Password for 'user':
            Peg location detected: r10248 project/trunk
            Fetching SVN history... Done.
            Growing trees... Done.
            Project origin detected: r1 project/trunk
            Building branches layouts... Done.
            Combing beards... Done.
            Generating SVN to Git mapping... Done.

            CONFIGURATION SUCCESSFUL

            To complete SubGit installation do the following:

            1) Adjust Subversion to Git branches mapping if necessary:
                /var/opt/gitlab/git-data/repositories/user/project.git/subgit/config
            2) Define at least one Subversion credentials in default SubGit passwd file at:
                /var/opt/gitlab/git-data/repositories/user/project.git/subgit/passwd
               OR configure SSH or SSL credentials in the [auth] section of:
                /var/opt/gitlab/git-data/repositories/user/project.git/subgit/config
            3) Optionally, add custom authors mapping to the authors.txt file(s) at:
                /var/opt/gitlab/git-data/repositories/user/project.git/subgit/authors.txt
            4) Run SubGit 'install' command:
                subgit install ./project.git



    • Enable post-receive hook:

      No Format
      $ git config -f GIT_REPO/subgit/config svn.triggerSvnPostReceive true

      where

      • GIT_REPO  – a path to the new Git repository where data from the SVN project will be imported to.
         

    • Specify authors mappingUpdate

      Configure authors mapping in default authors mapping file:

      No Format
      GIT_
      REPOS
      REPO/subgit/authors.txt
      file or change

      Or change core.authors option to point to  option so that it points to the global authors mapping file.

      Find more details about authors mapping in Import book

    • There are several methods to configure authentication to access SVN server, but we use plain text password file here to simplify the guide. If this method does not fit your needs - find authentication details in Remote book.

    Specify an username and password to be used by SubGit in subgit/passwd file.

    • the Authors mapping article.


    • Specify a username and password that are used by SubGit to access the SCN repository. Edit passwd file:

      No Format
      GIT_REPO/subgit/passwd

      By default, there's

    the '

    • only subgit secret

    ' credential pair in the file; replace it by 'user password' pair to be used to access SVN server by SubGit.

  7. Perform SubGit installation into local Git repository:

    • Install SubGit into the repository by the command:

      $ subgit-3.2.4/bin/subgit install GIT_REPO

      see command example --> (to be placed in drop-down block):

      $ subgit install /home/user/repo.git

      SubGit version 3.2.4 ('Bobique') build #3670

      Translating Subversion revisions to Git commits...

      Subversion revisions translated: 10248. Total time: 2 hours 15 minutes 23 seconds.

      INSTALLATION SUCCESSFUL

      Your copy of SubGit is not registered for repository at '/home/user/repo.git'.

      Obtain registration key at http://www.subgit.com/ and register SubGit with 'register' command; registration is free for Open Source, Educational and Startup projects.

      To uninstall SubGit use 'uninstall' command.

  8. Sync local Git repository with GitHub

    • step into newly created local Git repository $ cd GIT_REPO

    • add remote to the local Git repository $ git remote add github GITHUBREPO > **To be added into pop-up cloud (when hovering on GITHUBREPO): > > GITHUB_REPO** - GitHub remote repository URL

see command example --> (to be placed in drop-down block):

$ git remote add github https://github.com/user/project
            
    - enable caching your GitHub password in Git:
    
        - in Linux:
        
               $ git config --global credential.helper cache
                
        - in MacOS X:
        
               $ git config --global credential.helper osxkeychain    
            
    - push local repository content into GitHub repository
    
            $ git push github --all --follow-tags
            
    you'll be asked for GutHub credentials; once provided they will be cached for future push requests.

see command example --> (to be placed in drop-down block):

...

    •  credential pair. Replace it with a username and its corresponding password.

      Info
      titleSVN authentication

      There are several methods to configure authentication to access SVN server, but we use a plain text password file here to simplify the guide. See more authentication methods in SVN Authentication if this method does not fit your needs.


  2. Perform SubGit installation into local Git repository:

    No Format
    $ subgit install GIT_REPO

    where 
       GIT_REPO  – a path to the new Git repository where data from the SVN project will be imported to.

    Expand
    titleSee subgit install example…


    Code Block
    languagetext
    themeFadeToGrey
    titlesubgit install
    $ subgit install /home/user/repo.git

  SubGit version 3.2.4 ('Bobique') build #3670

  Translating Subversion revisions to Git commits...

  Subversion revisions translated: 10248.
  Total time: 2 hours 15 minutes 23 seconds.

  INSTALLATION SUCCESSFUL

  Your copy of SubGit is not registered for repository at '/home/user/repo.git'.

  Obtain registration key at http://www.subgit.com/ and register SubGit with 'register' command;
  registration is free for Open Source, Educational and Startup projects.

  To uninstall SubGit use 'uninstall' command.



  3. Sync local Git repository with GitHub:

    • step into newly created local Git repository 

      No Format
      $ cd GIT_REPO


    • add a remote to the local Git repository:

      No Format
      $ git remote add github GITHUB_REPO

      where 

      • GITHUB_REPO – GitHub project URL.


    • enable caching your GitHub password in Git:

      • in Linux:

        No Format
        $ git config --global credential.helper cache


      • in MacOS X:

        No Format
        $ git config --global credential.helper osxkeychain


    • push local repository content into GitHub repository:

      Expand
      titleSee git push command…


      Code Block
      languagetext
      themeFadeToGrey
      titlegit push
      $ git push github --all --follow-tags --force



      Expand
      titleSee git push example…


      Code Block
      languagetext
      themeFadeToGrey
      titlegit push
      $ git push github --all --follow-tags --force

Username for 'https://github.com': user
Password for 'https://user@github.com': 
Counting objects: 212, done.
Delta compression using up to 2 threads.
Compressing objects: 100% (193/193), done.
Writing objects: 100% (212/212), 19.24 KiB | 0 bytes/s, done.
Total 212 (delta 109), reused 0 (delta 0)
remote: Resolving deltas: 100% (109/109), done.
To https://github.com/user/project.git
 * [new branch]      Lib_test -> Lib_test
 * [new branch]

...

    • ano_

...

    • branch ->

...

    • ano_

...

    • branch

...

    • * [new branch]

...

    • another_

...

    • full ->

...

    • another_

...

    • full
 * [new branch]      br_

...

    • rev31 -> br_

...

    • rev31
 * [new branch]      br_rev33 -> br_rev33

...

    • * [new branch]

...

    • br_

...

    • rev35 ->

...

    • br_

...

    • rev35
 * [new branch]      br_rev37

...

    • -> br_rev37
 * [new branch]      branch_rev27

...

    •  -> branch_rev27

...

    • 
 * [new branch]      branch_rev27_1 -> branch_rev27_1

...

    • * [new branch]      bugs/b_4517 -> bugs/b_4517

...

    •

...

    • * [new branch]      bugs/rev39_b1 -> bugs/rev39_b1

...

    •

...

    • * [new branch]      bugs/rev39_b2 -> bugs/rev39_b2

...

    •  * [new branch]      feat_4489 -> feat_4489

...

    • 
 * [new branch]      features/feat_4510 -> features/feat_4510

...

    •

...

    • * [new branch]      features/feat_5612 -> features/feat_5612

...

    • * [new branch]      features/feat_5614 -> features/feat_5614

...

    • * [new branch]

...

    •

...

    •

...

    •  features/rev39_f1

...

    •  -> features/rev39_f1
 * [new branch]      features/rev39_f2 -> features/rev39_f2

...

    •

...

    • * [new branch]      full_branch -> full_branch

...

    •

...

    • * [new branch]      john_br -> john_br

...

    •  * [new branch]      master -> master

...

    •  * [new branch]      new_branch -> new_branch

...

    •

...

    • * [new branch]      snapshots/rev39_s1 -> snapshots/rev39_s1

...



    • create post-receive 
...
    •  hook 
...
    •  script 
...
    •  and 
...
    •  make 
...
    •  it 
...
    • executable:
       No Format
      $ echo 'git push --all --follow-tags github' > GIT_REPO/hooks/user-post-receive

...
    • $ chmod ug+x GIT_REPO/hooks/user-post-receive

     Warning
    titleMirroring limitation
    In order to maintain a reliable two-way mirror using the setup described above, Git users have to push their changes to the SubGit-managed Git repository rather than submitting changes to the GitHub repository directly.
...
  1. Try and buy
     

  2. Try and buy.
     Info
    titleTrial period
    Note: the trial period for SubGit mirror is 30 days, after that period you should buy a license key at https://subgit.com/pricing. 
    Once you receive an email with a license key, upload this license key to your server and run the following command:
     No Format
    $ sudo subgit register --key subgit.key GIT_REPO
...
  1. where
         GIT_REPO – a path to your newly created Git repository.
     Expand
    titleSubgit register example…

     Code Block
    languagetext
    themeFadeToGrey
    titlesubgit register
    $ sudo subgit register --key subgit.key /home/user/repo.git


...
  1.    
...
  1. SubGit version 3.2.4 ('Bobique') build #3670


...
  1.    
...
  1. Registration information:

     
...
  1. Registered for:       Example company

...
  1.      
...
  1. Purchase ID:          OS-111111111111111
     
...
  1. Expiration date:      April 23, 2028


...
  1.      You may use this key to register 9 more repositories (out of 10).
...
  1. 


...
  1.    REGISTRATION SUCCESSFUL

   Thank you for registering SubGit!

...
  1.    
...
  1. Visit http://www.subgit.com/ in case you have any questions and for more information on SubGit.
...


  2. Get support.

    If you have encountered any problems, see the following guides for more details:

     
Should you need any assistance, don't hesitate to contact us at support@subgitat support@tmatesoft.com.