From The Mana World
(Maybe this is becoming way too much text...)
 
m (Move page script moved page Dev:Git repository to Development:Git repository: Rename Dev: to Development: so the miraheze import works)
 
(80 intermediate revisions by 22 users not shown)
Line 1: Line 1:
This page provides some information about our switch to git (which we're slowly trying to make, starting with the tmwserv project). As an initial comforting note, git really isn't so complicated as some people would have you believe. A few months ago I became familiar with distributed version control by using Mercurial, and since a few weeks we're using git at work. I think we'll benefit a lot from switching to it on the long run.
{{category:outdated}}
==Git==
 
'''git''' is the name of the program intended to allow a team to work on a set of program sources, keep versions synchrone and make members team work easily known from others.
[https://gitlab.com/ GitLab] and [https://github.com/ github] are websites that provide free hosting of public git repositories.
At some point we moved the content repositories from gitorious to github and later to gitlab. See this forum topic [http://forums.themanaworld.org/viewtopic.php?p=121526#p121526] for reference. (Note server code was transferred to github since it was written)
We are using the version control system Git as our main collaboration tool. You can use it to obtain all the sourcecode and content files you need to  participate in the development or to create your own fork.
 
See [http://en.wikipedia.org/wiki/Git_(software) the wikipedia article about Git] and [http://git-scm.com/ the Git homepage] for details about Git.
 
In TMW wiki, information about Git is still located in several places where you may find contradictory information. We do apologize for that and work hard to let you have a clear information:
* '''This page''': The actual links to various repositories should be up to date but some information about how to work with it is not.It still contains useful information and GUI's information should be correct.  
* '''[[How to Develop]]''' also duplicates some info which you can find else where. It will be completely re-written  to make it the entry point of the  wiki development part.
* '''[[Working With Git]]''' contains the most up to date information to use Git with the command line. ''It is the actual reference that you should follow''. It is important to read it even if you plan to use a graphical user interface.


== The primary repository ==
== The primary repository ==


With git, everybody has his own repository. But of course we will keep a central repository through which we cooperate. This central repository is currently hosted at [http://gitorious.org/ gitorious.org], a friendly website that is also open source. It uses ssh's private/public key authentication for identifying committers.
=== Initial setup ===
 


* '''Our project page:''' http://gitorious.org/projects/tmwserv
With Git, we'll have one repository for each project. The central repositories through which we cooperate are hosted on '''[https://gitlab.com/ gitlab.com]'''. '''gitlab''' is a friendly website. On '''gitlab''' the main repository for each project is called ''master''. Once you click to the master repository, you can see several ways to clone it (the new <code>svn checkout</code>).


On Gitorious you can have multiple repositories for each project. The main one (and I suggest we keep just one for the moment) is called ''mainline''. Once you click to the mainline repository, you can see several ways to clone it (the new 'svn checkout'). For development purposes you should clone the "Push url", but this requires that you have:
We've categorized all projects related to The Mana World, as well as the repositories for each project, so you can easily see the complete [https://gitlab.com/themanaworld list of The Mana World projects] on '''gitlab'''. The projects have different forks (clone) URLs for browsing, read-only or developer access. The URL for developer access is called the "push URL", since it allows you to push commits into the repository via ssh. We still host some content on [https://github.com/themanaworld GitHub] and on [https://gitlab.com/evol Evol's GitLab].


# Signed up to gitorious.org
Git uses ssh's private/public key authentication for identifying committers. For development purposes just clone the read-only URL, it will automatically switch to the push URL if you have:
 
# Signed up to gitlab.com
# Generated a private/public ssh keypair (if you haven't got this already)
# Generated a private/public ssh keypair (if you haven't got this already)
# Filled in your public key in your account details on Gitorious
# Filled in your public key in your account details on GitLab
# Been added with commit rights to the repository
# Followed the directions in the [How to Develop] page
 
You can also push over HTTPS but that's not advised, and will require configuring a push token.


== Working with git ==
== Working with git ==
All TMW specific repositories have been moved to github: [https://github.com/themanaworld https://github.com/themanaworld]


=== Commit ===
Most were later moved to GitLab, but not all of them: [https://gitlab.com/themanaworld https://gitlab.com/themanaworld]


From now on, a commit is something you do locally. Others won't see your change on Gitorious unless you push it there. You'll notice committing is very fast, and you can commit multiple times before you decide to push. You can also make corrections to your last commit.
And as of 2024 everything which doesn't use GitHub Pages or GitLab Pages is on [https://git.themanaworld.org/explore/groups https://git.themanaworld.org/explore/groups]


Before you start committing, it is important to identify yourself to git, so that it can include the correct authorship information with your commit. You are no longer identified with a username, as was the case with Subversion. You can read exactly how to do this, as well as other useful information geared towards people switching from Subversion, on this page:
:::'''[[Working With Git]]'''


* '''Git - SVN Crash Course:''' http://git.or.cz/course/svn.html
You may also have a look to the original documentation at [http://git-scm.com/documentation http://git-scm.com/documentation]


=== Pushing ===
* '''gitk''': A simple but effective tool that visualizes the history and some of your current state. Run with <code>--all</code> to have it show all branches, otherwise it will just show stuff relevant to your current branch.
* '''tig''': A textual interface, rather similar to an email reader.
* '''git gui''': A gui tool like gitk which helps you prepare and perform your commits. Also makes it easier to understand the index concept.
* '''Giggle'''
* '''qgit'''
* '''git-cola''' : [http://git-cola.github.com/ http://git-cola.github.com/]
* '''SmartGit''' : [http://www.syntevo.com/smartgit/index.html http://www.syntevo.com/smartgit/index.html]'


Once you have committed some stuff, you can push these to the repository on Gitorious using <code>git push</code>. This works since by default the push command pushes to a ''remote'' called ''origin'', and this remote is automatically set up when you clone. However, the push will fail if there have been commits on the remote repository. In that case, you'll first have to pull in these changes (just like with Subversion, however Subversion allowed this as long as the same files weren't touched, git doesn't).
=== git on Windows ===


=== Pulling ===
When using git on Windows you might use [http://msysgit.github.com/ msysgit]. If you notice that some files seem to have changed after doing a fresh clone, you may want to disable <code>core.autocrlf</code> using <code>git config core.autocrlf false</code>. However, this is not recommended for contributors since the setting makes sure you don't commit Windows style newlines into the repository. Commiting Windows Newlines causes changes to be rejected by the linter. When encountering this problem it is usually best to consult other developers about the affected files.


When you want to get the latest changes from the repository on Gitorious, you generally use <code>git pull</code>. However, note that this command does not work when you have local changes. Also, when you have local commits, the pull command will generate a merge commit (and before that you may have to resolve some conflicts).
GitHub works uses the same tools as Git.
:'''GUIs'''
* '''GitHub for Windows''' : [http://windows.github.com/ http://windows.github.com/]
* '''Git Extensions''' : [http://code.google.com/p/gitextensions/ http://code.google.com/p/gitextensions/]
* '''git-cola''' : [http://git-cola.github.com/ http://git-cola.github.com/]
* '''SmartGit''' : [http://www.syntevo.com/smartgit/index.html http://www.syntevo.com/smartgit/index.html]


If you don't want to create merge commits, but would rather stack your local commits on top of any incoming commits, you should use <code>git pull --rebase</code>. This ''rebases'' your local commits on top of the incoming ones. You should never do this when you have pushed these commits elsewhere, so only do it when you are sure the commits are only on your machine.
Both GitHab and GitLab have a Web IDE.


If you have local changes and want to update your checkout, then there are several options:
=== git on MacOS X ===
MacOSX is an unix system, BSD derived. Git works there mostly as on Linux systems. Go to the [http://git-scm.com/downloads official download site: http://git-scm.com/downloads] and choose the OS X link, download and install. You also may prefer [http://code.google.com/p/git-osx-installer/ http://code.google.com/p/git-osx-installer/] and add  a graphical user interface later (links are on the same pages). Xcode and X11 are required if you want to install from sources. French users may also like: [https://gist.github.com/656299 https://gist.github.com/656299]
:'''GUIs'''
* '''GitHub for Mac''' github
has it's own application that you can find at [http://mac.github.com/ http://mac.github.com/]. Among others, it has a very nice feature to be able to pull and push in one operation.
* '''GitX''' : [http://gitx.laullon.com/ http://gitx.laullon.com/]
* '''SourceTree''' : [http://www.sourcetreeapp.com/ http://www.sourcetreeapp.com/]
* '''git-cola''' : [http://git-cola.github.com/ http://git-cola.github.com/]
* '''SmartGit''' : [http://www.syntevo.com/smartgit/index.html http://www.syntevo.com/smartgit/index.html]


* You commit your local changes, and do a pull, optionally with --rebase.
===Glossary===
* Or you use <code>git stash</code> to place your local changes on a "hidden" stash. Then, after pulling, you apply your changes again with <code>git stash apply</code>.
You may like this very nice interactive memo: '''[http://ndpsoftware.com/git-cheatsheet.html git-cheatsheet]''' by [https://github.com/ndp Andrew Patterson] from NDP software.
* Or you create a patch of your local changes that you apply again after the pull. This approach sometimes makes sense, but I would say in general it's the more clumsy way to go. There are git commands that help you with this though.


=== Resolving conflicts ===
* Branch
* Clone
* Commit
* Fork
* Mainline
* Master
* Merge
* Origin
* Patch
* Pull
* Push
* Stash
* Tree


TODO
[[Category:Development]]

Latest revision as of 03:56, 27 March 2024

These are articles that require updating, moving to archive or deletion (see also Template:Delete).

Git

git is the name of the program intended to allow a team to work on a set of program sources, keep versions synchrone and make members team work easily known from others. GitLab and github are websites that provide free hosting of public git repositories. At some point we moved the content repositories from gitorious to github and later to gitlab. See this forum topic [1] for reference. (Note server code was transferred to github since it was written) We are using the version control system Git as our main collaboration tool. You can use it to obtain all the sourcecode and content files you need to participate in the development or to create your own fork.

See the wikipedia article about Git and the Git homepage for details about Git.

In TMW wiki, information about Git is still located in several places where you may find contradictory information. We do apologize for that and work hard to let you have a clear information:

  • This page: The actual links to various repositories should be up to date but some information about how to work with it is not.It still contains useful information and GUI's information should be correct.
  • How to Develop also duplicates some info which you can find else where. It will be completely re-written to make it the entry point of the wiki development part.
  • Working With Git contains the most up to date information to use Git with the command line. It is the actual reference that you should follow. It is important to read it even if you plan to use a graphical user interface.

The primary repository

Initial setup

With Git, we'll have one repository for each project. The central repositories through which we cooperate are hosted on gitlab.com. gitlab is a friendly website. On gitlab the main repository for each project is called master. Once you click to the master repository, you can see several ways to clone it (the new svn checkout).

We've categorized all projects related to The Mana World, as well as the repositories for each project, so you can easily see the complete list of The Mana World projects on gitlab. The projects have different forks (clone) URLs for browsing, read-only or developer access. The URL for developer access is called the "push URL", since it allows you to push commits into the repository via ssh. We still host some content on GitHub and on Evol's GitLab.

Git uses ssh's private/public key authentication for identifying committers. For development purposes just clone the read-only URL, it will automatically switch to the push URL if you have:

  1. Signed up to gitlab.com
  2. Generated a private/public ssh keypair (if you haven't got this already)
  3. Filled in your public key in your account details on GitLab
  4. Been added with commit rights to the repository
  5. Followed the directions in the [How to Develop] page

You can also push over HTTPS but that's not advised, and will require configuring a push token.

Working with git

All TMW specific repositories have been moved to github: https://github.com/themanaworld

Most were later moved to GitLab, but not all of them: https://gitlab.com/themanaworld

And as of 2024 everything which doesn't use GitHub Pages or GitLab Pages is on https://git.themanaworld.org/explore/groups

Working With Git

You may also have a look to the original documentation at http://git-scm.com/documentation

  • gitk: A simple but effective tool that visualizes the history and some of your current state. Run with --all to have it show all branches, otherwise it will just show stuff relevant to your current branch.
  • tig: A textual interface, rather similar to an email reader.
  • git gui: A gui tool like gitk which helps you prepare and perform your commits. Also makes it easier to understand the index concept.
  • Giggle
  • qgit
  • git-cola : http://git-cola.github.com/
  • SmartGit : http://www.syntevo.com/smartgit/index.html'

git on Windows

When using git on Windows you might use msysgit. If you notice that some files seem to have changed after doing a fresh clone, you may want to disable core.autocrlf using git config core.autocrlf false. However, this is not recommended for contributors since the setting makes sure you don't commit Windows style newlines into the repository. Commiting Windows Newlines causes changes to be rejected by the linter. When encountering this problem it is usually best to consult other developers about the affected files.

GitHub works uses the same tools as Git.

GUIs

Both GitHab and GitLab have a Web IDE.

git on MacOS X

MacOSX is an unix system, BSD derived. Git works there mostly as on Linux systems. Go to the official download site: http://git-scm.com/downloads and choose the OS X link, download and install. You also may prefer http://code.google.com/p/git-osx-installer/ and add a graphical user interface later (links are on the same pages). Xcode and X11 are required if you want to install from sources. French users may also like: https://gist.github.com/656299

GUIs
  • GitHub for Mac github

has it's own application that you can find at http://mac.github.com/. Among others, it has a very nice feature to be able to pull and push in one operation.

Glossary

You may like this very nice interactive memo: git-cheatsheet by Andrew Patterson from NDP software.

  • Branch
  • Clone
  • Commit
  • Fork
  • Mainline
  • Master
  • Merge
  • Origin
  • Patch
  • Pull
  • Push
  • Stash
  • Tree