LilyPond Contributor's Guide: 2.3 git-cl

[ << Quick start ]	[Top][Contents][Index][ ? ]			[ Working with source code >> ]
[ < How to use lily-git ]		[ Up : Quick start ]	[ Installing git-cl > ]

2.3 git-cl

Git-cl is a ‘helper script’ that uploads patches to Google’s Rietveld Code Review Tool – used by the developers for patch review – and, at the same time, updates LilyPond’s issue tracker.

[ << Quick start ]	[Top][Contents][Index][ ? ]			[ Working with source code >> ]
[ < git-cl ]		[ Up : git-cl ]	[ Updating git-cl > ]

Installing `git-cl`

Note: LilyDev users can jump straight to the next section on updating git-cl as it will already be installed in your home directory.

Download git-cl by running the command:

git clone https://github.com/gperciva/git-cl.git

or, if that command fails for any reason, try:

git clone git://github.com/gperciva/git-cl.git

Add the ‘git-cl/’ directory to your PATH or create a symbolic link to the git-cl and upload.py scripts in one of your PATH directories (e.g. ‘$HOME/bin’).
In GNU/Linux you can add directories to PATH by adding this line to your ‘.bashrc’ file located in your home directory:
```
PATH=~/directory_containing_git-cl:"${PATH}"
```

[ << Quick start ]	[Top][Contents][Index][ ? ]			[ Working with source code >> ]
[ < Installing git-cl ]		[ Up : git-cl ]	[ Configuring git-cl > ]

Updating `git-cl`

LilyDev users should make sure that they always have the latest version of git-cl installed. It is possible that changes have been made to git-cl that are not (yet) included in the version of LilyDev that you are using.

Using a terminal run the following commands:

cd ~/git-cl/
git pull

This will download and update you to the lastest version of git-cl.

[ << Quick start ]	[Top][Contents][Index][ ? ]			[ Working with source code >> ]
[ < Updating git-cl ]		[ Up : git-cl ]	[ Compiling with LilyDev > ]

Configuring `git-cl`

Set up login accounts

Because git-cl updates two separate websites (Google’s Rietveld Code Review Tool and LilyPond’s issue tracker) you must have a valid user account (login and password) for both sites.

For the Rietveld Code Review Tool you will need a Google account. Note that a Google account does not require that you have or use a ‘Google’ email address. You can use any email address for your Google account. Just select the option “I prefer to use my current email address” when you sign up.

Note: In order for git-cl to work, your Google Account Settings must have the ‘Access for less secure apps’ set to ‘Allowed’. This is normally the default setting.

For the LilyPond issue tracker, please request a user account by sending an email to the LilyPond Developer’s mailing list (lilypond-devel@gnu.org), preferably using the same email address that you want to use for your user login.

Authorizing git-cl for the LilyPond issue tracker

The git-cl command itself also needs to be ‘authorized’ so that it can access the LilyPond issue tracker.

Once you have been given a valid login for the LilyPond issue tracker, go to the ‘Account settings’ and select the ‘OAuth’ tab.
Locate the ‘Register New Application’ section and enter git-cl in the ‘Application Name:’ field.
Click on the ‘Register new application’ button. You should now see ‘git-cl’ listed under the ‘My Applications’ section.
Click on the ‘Generate Bearer Token’ button. You should now see ‘git-cl’ listed under the ‘Authorized Applications’ section along with a value for the ‘Bearer Token’ entry. This value is used, in the next steps, to allow git-cl to access and update the LilyPond issue tracker.

Installing ca-certificates

In order to have git-cl properly update issues on the SourceForge Allura issue tracker, you must have the package ca-certificates installed. You can check to see if the package is installed with

apt --installed list | grep ca-certificates

If ca-certificates is installed, you will get a result that shows the version that is installed. If it is not installed, there will be no version displayed.

Install ca-certificates with the following:

sudo apt-get install ca-certificates

Running git-cl for the first time

Using a terminal, move to the top level of the $LILYPOND_GIT directory and then run git-cl with the config option:
```
cd $LILYPOND_GIT
git-cl config
```
You will see a series of prompts. For most of them you can simply accept the default value by responding with a newline (i.e. by pressing return or enter).
The prompt for the Rietveld server (the patch review tool), which defaults to codereview.appspot.com
```
Rietveld server (host[:port]) [codereview.appspot.com]:
```
The prompt for the Allura server (the issue tracker), which defaults to https://sourceforge.net/p/testlilyissues/issues/
```
Allura server [https://sourceforge.net/p/testlilyissues/issues/]:
```
When prompted for the Allura bearer token copy/paste the value generated in the previous steps for Authorising git-cl for the LilyPond issue tracker
Allura bearer token (see https://sourceforge.net/auth/oauth/): fdbfca60801533465480
Note: The above is a ‘fake’ bearer token used just for illustration. Do not use this value.
Finally, the prompt for the CC list, which defaults to lilypond-devel@gnu.org, the LilyPond Developer’s email list.
```
CC list ("x" to clear) [lilypond-devel@gnu.org]:
```

The git-cl script should now be correctly configured for use.

[ << Quick start ]	[Top][Contents][Index][ ? ]			[ Working with source code >> ]
[ < Updating git-cl ]		[ Up : git-cl ]	[ Compiling with LilyDev > ]

2.3 git-cl

Installing git-cl

Updating git-cl

Configuring git-cl