Difference between revisions of "TheMagPiGit"

From eLinux.org
Jump to: navigation, search
(Setting up access)
(15 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{TheMagPiHeader}}
+
{{TheMagPiTeamHeader}}
  
* [[RPi_MagPi_InfoForAuthors|Information for authors]] - the process of submitting an article.
 
* [[TheMagPiLayout|Layout & fonts]] - description of the standard layout and associated fonts.
 
* [[TheMagPiPdf|PDF creation]] - instructions for the generation of PDF for electronic and paper publication.
 
  
  
== Raspberry Pi & github ==
+
== Setting up access ==
 
+
=== Setting up access ===
+
  
 
* The first step is to create a [https://github.com/ github] account.  Then for those on the MagPi layout team, email the editor for permission to join the github organisation.
 
* The first step is to create a [https://github.com/ github] account.  Then for those on the MagPi layout team, email the editor for permission to join the github organisation.
Line 15: Line 10:
  
  
=== Tools for Raspberry Pi or VirtualBox ===
+
== Tools for LINUX or OSX ==
  
Several people would rather not read the [http://git-scm.com/book/en/ git book].  Therefore, some scripts were written to simplify the usage slightly.
+
Several people would rather not read the [http://git-scm.com/book/en/ git book].  Therefore, some scripts were written to simplify the usage slightly.  Git is not a replacement for good communication.  Remember to update the local git repository before starting work on something and commit changes back to the repository frequently.
  
* Download [https://www.dropbox.com/s/ydtv56zlod95ptg/mp-git-20120208.tar.gz mp-git-20120208.tar.gz] from the DropBox.
+
* Download [https://www.dropbox.com/s/xnra5lnw61wrm8r/mp-git-20130321.tar.gz mp-git-20130321.tar.gz] from the DropBox.
 
* Unpack it,
 
* Unpack it,
 
<pre>
 
<pre>
tar xvfz mp-git-20120208.tar.gz
+
tar xvfz mp-git-20130321.tar.gz
 
</pre>
 
</pre>
 
* Install it,
 
* Install it,
Line 37: Line 32:
 
mp-git-setup.sh  
 
mp-git-setup.sh  
 
</pre>
 
</pre>
to install and configure git.  The script has no action if the installation and configuration is already okay.  
+
to install and configure git.  The script has no action if the installation and configuration is already okay.
  
 
==== mp-git-clone.sh ====
 
==== mp-git-clone.sh ====
  
Type
+
The script expects that the repositories will be in a parent directory called magpi-git.  (This can be overridden by setting the environmental variable MP_GIT_DIR to the full path of the parent directory.)  If the magpi-git directory does not already exist,
 +
<pre>
 +
mkdir magpi-git; cd magpi-git
 +
</pre>
 +
Then type
 +
<pre>
 +
mp-git-clone.sh 11
 +
</pre>
 +
to clone the issue 11 repository.  The script will not clone the repository again if a local copy already exists in the present working directory.  More than one repository can be requested at once.  For example,
 
<pre>
 
<pre>
mp-git-clone.sh
+
mp-git-clone.sh 11 12 13 templates
 
</pre>
 
</pre>
to check out the shinything repository.  The script will not check out the repository again if a local copy already exists in the present working directory.
+
will check out the issue 11, 12 and 13 repositories, as well as the templates repository.
  
 
==== mp-git-commit.sh ====
 
==== mp-git-commit.sh ====
Line 51: Line 54:
 
Type
 
Type
 
<pre>
 
<pre>
mp-git-commit.sh 'A message goes here'
+
mp-git-commit.sh 'A message goes here' [all]
 
</pre>
 
</pre>
where the string 'A message goes here' should be replaced with a sensible and informative message.
+
where the string 'A message goes here' should be replaced with a sensible and informative message and the text 'all' is optional.  If all is used, all repositories within the mp-git/ parent directory are checked.
The script commits to the local repository, fetches and remote changes and then merges the local changes into the
+
The script adds any new few files, commits to the local repository, fetches and remote changes and then merges the local changes into the remote repository. (Git does not allow empty directories to be added)
remote repository.
+
  
=== Using github ===
+
==== mp-git-update.sh ====
  
* At the start of an editing session (when you log into the Raspberry Pi), type:
+
Type
 
<pre>
 
<pre>
ssh-agent
+
mp-git-update.sh [all]
ssh-add
+
 
</pre>
 
</pre>
then enter your password for the ssh keyThis step needs to be rebooted each time you log into the Raspberry Pi.
+
to update the local copy with any changes from the github repository, where 'all' is optionalIf all is used, all repositories within the mp-git/ parent directory are checked.
  
* Then use the ssh read and write link from the github repository, e.g.:
+
==== Using Proxy ====
<pre>
+
If you need to use a proxy:
git clone git@github.com:someorg/reponame.git
+
HTTP_PROXY="http://username:pwd@theproxyserver.com:port/"
</pre>
+
  git config --global http.proxy $HTTP_PROXY
this will create a folder called reponame. The clone operation clones the repository to the local disk.
+

Revision as of 14:27, 9 April 2013

TheMagPi.png

Main Readers Authors Volunteers Sponsors Advertising Translations


  • Quick start guide - A quick start guide to help new volunteers get the information they need.
  • Information for volunteers - A guide to help volunteers familiarize themselves with the team’s workflow / tools.
  • Information for authors - the process of submitting an article.
  • MagPi MMS - how to use the MagPi MMS.
  • MagPi GIT - how to use the MagPi GIT scripts.
  • Layout & fonts - description of the standard layout and associated fonts.
  • PDF creation - instructions for the generation of PDF for electronic and paper publication.


Setting up access

  • The first step is to create a github account. Then for those on the MagPi layout team, email the editor for permission to join the github organisation.
  • Since the Raspberry Pi does not have a great deal of processor power, it is better to use the command line tools to access github. For OSX and Windows there are GUI tools available for download on the github site.


Tools for LINUX or OSX

Several people would rather not read the git book. Therefore, some scripts were written to simplify the usage slightly. Git is not a replacement for good communication. Remember to update the local git repository before starting work on something and commit changes back to the repository frequently.

tar xvfz mp-git-20130321.tar.gz
  • Install it,
cd mp-git
source install.sh
  • Then use the commands as needed. The commands are,

mp-git-setup.sh

Type

mp-git-setup.sh 

to install and configure git. The script has no action if the installation and configuration is already okay.

mp-git-clone.sh

The script expects that the repositories will be in a parent directory called magpi-git. (This can be overridden by setting the environmental variable MP_GIT_DIR to the full path of the parent directory.) If the magpi-git directory does not already exist,

mkdir magpi-git; cd magpi-git

Then type

mp-git-clone.sh 11

to clone the issue 11 repository. The script will not clone the repository again if a local copy already exists in the present working directory. More than one repository can be requested at once. For example,

mp-git-clone.sh 11 12 13 templates

will check out the issue 11, 12 and 13 repositories, as well as the templates repository.

mp-git-commit.sh

Type

mp-git-commit.sh 'A message goes here' [all]

where the string 'A message goes here' should be replaced with a sensible and informative message and the text 'all' is optional. If all is used, all repositories within the mp-git/ parent directory are checked. The script adds any new few files, commits to the local repository, fetches and remote changes and then merges the local changes into the remote repository. (Git does not allow empty directories to be added)

mp-git-update.sh

Type

mp-git-update.sh [all]

to update the local copy with any changes from the github repository, where 'all' is optional. If all is used, all repositories within the mp-git/ parent directory are checked.

Using Proxy

If you need to use a proxy:

HTTP_PROXY="http://username:pwd@theproxyserver.com:port/"
git config --global http.proxy $HTTP_PROXY