Editing CommunityData:Git
From CommunityData
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
== Getting Access to the CDSC Git Repository == | == Getting Access to the CDSC Git Repository == | ||
If you need access to the CDSC Git Repository, you should ask on the [[CommunityData:IRC|#communitydata IRC channel]] for access. If you need access to a specific repository only, mention which one. While you likely already know which repo you want access to, you can find the public ones on [https://code.communitydata.science/ code.communitydata.science], and a complete list of all of them <code>conf/gitolite.conf</code> file in the <code>gitolite-admin</code> git repository. If you are a new CDSC member, mention that you need to be added to the <code>@collective</code> group in Gitolite. Anybody in the collective who uses the Git repository will be able add you. | If you need access to the CDSC Git Repository, you should ask on the [[CommunityData:IRC|#communitydata IRC channel]] for access. If you need access to a specific repository only, mention which one. While you likely already know which repo you want access to, you can find the public ones on [[https://code.communitydata.science/| code.communitydata.science]], and a complete list of all of them <code>conf/gitolite.conf</code> file in the <code>gitolite-admin</code> git repository. If you are a new CDSC member, mention that you need to be added to the <code>@collective</code> group in Gitolite. Anybody in the collective who uses the Git repository will be able add you. | ||
== Install Git== | == Install Git== | ||
To get started, you will need to '''install git'''. Doing so requires different steps depending on your operating system. Basic instructions available from [https://git-scm.com/downloads the Git website]. | To get started, you will need to '''install git'''. Doing so requires different steps depending on your operating system. Basic instructions available from [https://git-scm.com/downloads the Git website]. | ||
Mac OS users should check out [https://www.moncefbelyamani.com/how-to-install-xcode-homebrew-git-rvm-ruby-on-mac/ this tutorial], which recommends also setting up the "Command Line Tools" as well as the "homebrew" package manager. If you follow the steps for installing git onto your machine, it is only necessary to do the first three (out of five). This includes downloading/installing the command line tools, installing Homebrew, and installing git itself. | |||
Note that RStudio also has Git integration now. Instructions and details available via [https://support.rstudio.com/hc/en-us/articles/200532077-Version-Control-with-Git-and-SVN RStudio support documentation]. | |||
You will also likely need to set it up so it knows what your name and email address is. You can do that like: | You will also likely need to set it up so it knows what your name and email address is. You can do that like: | ||
Line 16: | Line 18: | ||
Again | Again | ||
</source> | </source> | ||
== Configuring Git for submodules == | == Configuring Git for submodules == | ||
Line 27: | Line 27: | ||
These two commands will ensure that git works a little better with submodules. Submodules are essentially git repositories that are buried inside other git repositories. For example, the <code>wikiresearch</code> repository currently uses the <code>RCommunityData</code> repository as a submodule. If you're working in a repository like this, you'll want to use <code>git spull</code> instead of just <code>git pull</code> which will also check for and pull changes made in any of your submodules. | These two commands will ensure that git works a little better with submodules. Submodules are essentially git repositories that are buried inside other git repositories. For example, the <code>wikiresearch</code> repository currently uses the <code>RCommunityData</code> repository as a submodule. If you're working in a repository like this, you'll want to use <code>git spull</code> instead of just <code>git pull</code> which will also check for and pull changes made in any of your submodules. | ||
== Gitolite Server == | == Gitolite Server == | ||
Line 36: | Line 32: | ||
We have a private git server which uses [http://gitolite.com/gitolite/index.html gitolite] to manage permissions for git repositories. It's like a private Github server that hosts our respositories, but just ours, and on our server. | We have a private git server which uses [http://gitolite.com/gitolite/index.html gitolite] to manage permissions for git repositories. It's like a private Github server that hosts our respositories, but just ours, and on our server. | ||
=== | === Dependencies === | ||
Once you've got git installed, you will also need a [https://help.github.com/articles/generating-ssh-keys/ public SSH key]. You can send your public key (usually ~/.ssh/id_rsa.pub) to a current administrator (see the list of administrators below on this page), and they can add you as a new user. | Once you've got git installed, you will also need a [https://help.github.com/articles/generating-ssh-keys/ public SSH key]. You can send your public key (usually ~/.ssh/id_rsa.pub) to a current administrator (see the list of administrators below on this page), and they can add you as a new user. | ||
Line 52: | Line 48: | ||
=== Creating a new repository === | === Creating a new repository === | ||
To create a new repository, you will need to have admin rights. Currently, | To create a new repository, you will need to have admin rights. Currently, the administrators are Kaylea, Nate, Jeremy, Aaron, Mako, Sayamindu, and Jim. If you'd like to be an administrator, you should contact one of them! | ||
If you are all already administrator, this describes how you will create a new repository. | |||
First, you will need to clone the gitolite-admin repository | First, you will need to clone the gitolite-admin repository | ||
Line 70: | Line 68: | ||
would create a new repository at git@code.communitydata.science:foo with aaron and mako as admins, and give jdfoote read-only access *once this file was saved, committed, and pushed*. | would create a new repository at git@code.communitydata.science:foo with aaron and mako as admins, and give jdfoote read-only access *once this file was saved, committed, and pushed*. | ||
That means you need to: | |||
# Save the file (i.e., with text editor) | # Save the file (i.e., with text editor) | ||
# Add the file with (with <code>git add conf/gitolite.conf</code>) | # Add the file with (with <code>git add conf/gitolite.conf</code>) | ||
# Commit the file (with <code>git commit</code>) (this will | # Commit the file (with <code>git commit</code>) (this will throw you in vi/vim) | ||
# Push the file back to the server (with <code>git push</code>) | # Push the file back to the server (with <code>git push</code>) | ||
Line 83: | Line 81: | ||
$ cd foo | $ cd foo | ||
$ git remote add origin git@code.communitydata.science:foo | $ git remote add origin git@code.communitydata.science:foo | ||
$ git push --set-upstream origin | $ git push --set-upstream origin master | ||
</source> | </source> | ||
Line 101: | Line 99: | ||
{{note}} This is still experimental, and may go away. Don't put files in it without a backup. | {{note}} This is still experimental, and may go away. Don't put files in it without a backup. | ||
Git is not a very good system for managing large files, which is a problem for us, since we often have large data files. Enter [https://git-annex.branchable.com/walkthrough/ git-annex], a system that works in tandem with git and lets you store large files (but avoids using git as the data store). Our gitolite installation supports git-annex. To start using git-annex, install git-annex locally in your computer. Most GNU/Linux distributions have git-annex packages. Then, in your existing git repository execute the following initialization command: | |||
Git is not a very good system for managing large files, which is a problem for us, since we often have large data files. Enter [https://git-annex.branchable.com/walkthrough/ git-annex], a system that works in tandem with git and lets you store large files (but avoids using git as the data store). Our gitolite installation supports git-annex. To start using git-annex, install git-annex locally in your computer. Most GNU/Linux distributions have git-annex packages. | |||
Then, in your existing git repository execute the following initialization command: | |||
<source lang='bash'> | <source lang='bash'> | ||
Line 127: | Line 120: | ||
$ git annex copy --to origin | $ git annex copy --to origin | ||
</source> | </source> | ||
Once these commands are successful, your collaborators should be able to get the file with the following command (assuming that they have already run <code>git annex init</code>): | Once these commands are successful, your collaborators should be able to get the file with the following command (assuming that they have already run <code>git annex init</code>): | ||