I often do this – I work away on my master branch and suddenly realise ‘damn I should have branched before I started this’. Usually this happens because what I think will be a trivial change snowballs into something much more sweeping. I thought I would record here how to deal with situations like this... Read more »
This post is for those of you that build QGIS on a regular basis and want to keep up with everything going on in the current release branches (1.7.2 and 1.8) as well as the master branch that will eventually become version 2.0.
While you can do all your work in one clone, this method has a couple of advantages, at the expense of a bit of disk space:
- Quicker compiles compared to branch switching, especially if you are using ccache
- Less likelihood of making a merge mess when switching branches
The basic steps are:
- Login to github and clone the QGIS repository (https://github.com/qgis/Quantum-GIS)
- Create a working copy of your github clone on your machine
- Add a reference to the upstream repository
- Fetch and merge (if required) from the upstream repository
- Create a new clone for the branch by cloning the working copy created in step 2
- Change to the branch clone directory
- Add the upstream remote
- Fetch from upstream
- Create the tracking branch
- Checkout the branch
It’s simpler than it sounds—the following steps should work on any platform and assume you have already created your own clone of the QGIS repository on github.
First make a directory for development, change to it, and fetch a copy of your clone of QGIS from github (this will take a while):
gsherman@dork:~$ mkdir qgis_dev
gsherman@dork:~$ cd qgis_dev
gsherman@dork:~/qgis_dev$ git clone firstname.lastname@example.org:g-sherman/Quantum-GIS.git
Cloning into Quantum-GIS...
remote: Counting objects: 183812, done.
remote: Compressing objects: 100% (42255/42255), done.
remote: Total 183812 (delta 140627), reused 183281 (delta 140221)
Receiving objects: 100% (183812/183812), 240.80 MiB | 1.19 MiB/s, done.
Resolving deltas: 100% (140627/140627), done.
Now change to your new clone directory and add the upstream repository (the QGIS repo on github):
gsherman@dork:~/qgis_dev$ cd Quantum-GIS/
gsherman@dork:~/qgis_dev/Quantum-GIS$ git remote add upstream email@example.com:qgis/Quantum-GIS.git
We can then list our config to see that the remote was added:
gsherman@dork:~/qgis_dev/Quantum-GIS$ git config --list
Then we do a fetch from the QGIS repo to make sure things are up to date:
gsherman@dork:~/qgis_dev/Quantum-GIS$ git fetch upstream
If your clone of the QGIS repository on github is not brand new, you should do a merge before proceeding:
gsherman@dork:~/qgis_dev/Quantum-GIS$ git merge upstream/master
Now we can create a new clone for the 1.7.2 branch using our local master:
gsherman@dork:~/qgis_dev/Quantum-GIS$ cd ..
gsherman@dork:~/qgis_dev$ git clone ./Quantum-GIS Quantum-GIS-1_7_2
Cloning into Quantum-GIS-1_7_2...
Now we need to add the remote for the main QGIS repository:
gsherman@dork:~/qgis_dev$ cd Quantum-GIS-1_7_2/
gsherman@dork:~/qgis_dev/Quantum-GIS-1_7_2$ git remote add upstream firstname.lastname@example.org:qgis/Quantum-GIS.git
The next step is to fetch from upstream to make sure we have references to the branches:
gsherman@dork:~/qgis_dev/Quantum-GIS-1_7_2$ git fetch upstream
* [new branch] dev-threading -> upstream/dev-threading
* [new branch] master -> upstream/master
* [new branch] release-0_0_11 -> upstream/release-0_0_11
* [new branch] release-0_0_12 -> upstream/release-0_0_12
* [new branch] release-1_7_1 -> upstream/release-1_7_1
* [new branch] release-1_7_2 -> upstream/release-1_7_2
* [new branch] release-1_8 -> upstream/release-1_8
Now we create the branch to track the release of interest—in this case 1.7.2:
gsherman@dork:~/qgis_dev/Quantum-GIS-1_7_2$ git branch --track release-1_7_2 upstream/release-1_7_2
Branch release-1_7_2 set up to track remote branch release-1_7_2 from upstream.
The last step is to check out the branch which should go pretty quick:
gsherman@dork:~/qgis_dev/Quantum-GIS-1_7_2$ git checkout release-1_7_2
Checking out files: 100% (1809/1809), done.
Switched to branch 'release-1_7_2'
You are now ready to build the 1.7.2 release branch. Repeat the process for any other branches you want to track.
Here is a quick video I did this morning using the very cool tool Gource. The video shows all the commits (1265) that were made between release 1.6 and 1.7. QGIS 1.7 was released on 19th June 2011 but there was still some clean up in the 1.7 branch paste that date into September.
It’s interesting to note the large burst of activity around November.
Filed under: Open Source, qgis Tagged: FOSSGIS, gis, git, Gource, Open Source, qgis, Quantum GIS
Tonight Tim Sutton officially made the release announcement for QGIS 1.7, so I’m guess I’m free to blog about the newest version now and its cool features.
What are you still doing here? Go and get it! http://www.qgis.org/wiki/Download
I am, as a heavy QGIS user and a guy-who-tries-to-write-features-and-patches-for-the-code, very happy with this release. I know a lot of people have put a lot of hard work and free time into working on features and bug fixes that keep making this free GIS system even better.
Some of the more notable new features in this release are…well there are just way to many for me to list here so go and check out the official list at http://qgis.org/component/content/article/127-qgis-1-7-release.html
The QGIS team has shifted their source control system to using GIT, which I am very happy about as a lot of the guys on the #qgis IRC channel will know :). The bug tracer has also been moved tohttp://hub.qgis.org/projects/quantum-gis.
Since the release of QGIS 1.6 there have been 1199 commits (using git to count: git log –pretty=oneline upstream/release-1_6_0..upstream/release-1_7_0 | wc -l). Not a bad effort if I may so myself.
If you are still reading this, I really hope it’s because you are waiting for QGIS 1.7 to install.
Filed under: Open Source, qgis Tagged: gis, git, mapping, Open Source, OSS, qgis, Quantum GIS
I forked the QGIS repo on GitHub a little while ago although one thing that bothered me was that it gave me copies of all the branches that the main QGIS git repo had. This is understandable as it’s the way it works however I don’t really need all these branches in my forked copy of the repo as I don’t care about them. I only care the ones I am working on, and I don’t want to see a big list of branches in my git fork that have nothing to do with me.
So the next question was how do I delete all the branches on the remote repo at GitHub. Well you would normally do:
git push origin :branch_name
although doing that by hand for each branch is, well, a pain in the butt! After a chat with a guy (strk) on the #qgis IRC channel who is more skilled at bash then me (I’m still a Linux noob) he came up with this:
git branch -r | grep origin/ | grep -v master | grep -v HEAD| cut -d/ -f2 | while read line; do git push origin :$line; done;
Filed under: Open Source, qgis Tagged: git, Open Source, OSS, qgis, Quantum GIS
Writing a QGIS plugin is not overly complicated but represents a bit of work. Using
git in conjunction with your development efforts can make sure your investment in
coding time is preserved.
The QGIS project team has set up a central location for plugin development which includes pretty much everything you need to develop and support your plugins, including:
- Issue tracking
The repository feature allows you to create a central place to store your plugin code using git. Others can clone your repository and contribute through patches or pull requests.
Creating a Plugin
The chore of setting up the boilerplate for a plugin is made simple by using the Plugin Builder. Previously this was a web application but it has now been replaced by a QGIS plugin aptly named Plugin Builder. You can install Plugin Builder from within QGIS by selecting Fetch Python Plugins… from the Plugins menu.
Once Plugin Builder is installed you can quickly create a starter plugin that implements a simple dialog box with OK and Cancel buttons. The plugin created by Plugin Builder is fully functional—it will load in QGIS but not do anything useful until you customize it.
Setting up the Workflow
You have a couple of options for setting up your development directory and workflow:
- Copy your plugin template to the QGIS plugin directory, initialize the git repository, and develop from there.
- Work within your plugin template directory that was created by Plugin Builder (not within the QGIS plugin directory)
Option one is very convenient as long as you don’t test the uninstall feature of your plugin. This will delete your entire plugin directory and git repository—not what we really want.
Option two is safer, however to test your plugin you have to continually copy from your development area to your QGIS plugin directory. Alternatively you could make commits and pull from your development area to the copy (assuming it is a git repo) in the QGIS plugin directory. If you are on a unix based system you could also create a Makefile to deploy the plugin for you.
The best solution is to use option two and use the QGIS_PLUGINPATH environment variable to point to your development directory. When present, QGIS_PLUGINPATH tells QGIS to search additional directories for plugins. Going this route allows you to develop in the directory created by Plugin Builder and test your plugin without any copying or pulling. The upside to this is since your plugin wasn’t installed through the Plugin Installer it can’t be uninstalled accidentally. When you are ready to test the uninstall and unloading of your plugin you can copy it to the main QGIS plugin directory.
Note: If you are using Windows there was a problem specifying QGIS_PLUGINPATH with colons in the path. This issue is fixed in revision 15073 and will make it into the next release.
No matter how you implement your workflow I suggest creating a repository on the QGIS hub (http://hub.qgis.org) or github.com.
Here is a summary of the steps to get started. We’ll assume your new plugin is named zoomer:
- Install Plugin Builder
- Create a directory that will contain all your plugins, for example my_plugins
- Create your plugin template using Plugin Builder. Be sure to select my_plugins when Plugin Builder asks where to create your plugin.
- Change to your plugin directory (e.g. my_plugins/zoomer) created by Plugin Buidler and create a git repository using:
- Set the QGIS_PLUGINPATH evironment variable to point to the directory containing your plugin directory (my_plugins). Be sure to use the full path to my_plugins
- Start QGIS and use the Plugin Manager (Manage Plugins… from the Plugins menu) to enable your plugin. If it doesn’t show up in the list of plugins check to make sure you have set QGIS_PLUGINPATH correctly.
- Develop away, testing as you go. Make sure to commit changes regularly and push them to your repository on hub.qgis.org.
If you are new to git, take a look at the Pro Git book at http://progit.org/.
For help on developing QGIS plugins with Python, see the PyQGIS Cookbook.
A couple of days I found a pretty cool open source project for visualizing the history of version controlled code. The project is called Gource and can be found here: http://code.google.com/p/gource/ On the videos wiki page there are a few videos of other projects that have used gource to generate cool videos of their commit history so I thought I should make one for QGIS.
After downloading and building the latest source for Gource and fetching the current trunk of QGIS following these instructions: http://spatialgalaxy.net/2010/12/27/contributing-to-qgis-using-git/ I ran the following in my terminal on my Ubuntu machine, with my current directory being the download git repo from the above instructions:
gource --title "Quantum GIS" --logo images\icons\qgis-icon.png \ --hide filenames --date-format "%d, %B %Y" --seconds-per-day 0.15 \ --highlight-all-users --auto-skip-seconds 0.5 --file-idle-time 0 --max-files 999999999 \ --multi-sampling --stop-at-end --elasticity 0.1 -b 000000 \ --disable-progress --user-friction .2 --output-ppm-stream - | \ ffmpeg -an -threads 4 -y -b 3000K -vb 8000000 -r 60 -f image2pipe \ -vcodec ppm -i - -vcodec libx264 -vpre libx264-medium qgis.mp4
Don’t worry I know it looks crazy but it’s really not that bad. I’ll break it down.
- –title “Quantum GIS” Well, yeah, adds a title to the project.
- –logo images/icons/qgis-icon.png Adds a icon watermark
- –hide filenames This hides the filenames of the files being committed . I hide these because it makes it pretty hard to see.
- –date-format “%d, %B %Y” Formats the date at the top of the video.
- –seconds-per-day 0.15 How many seconds represent a day. The lower this is the fast a day goes by, meaning me commits in less time.
- –highlight-all-users Highlights all the users all the time.
- –auto-skip-seconds 0.5 If there are no commits for this time it will skip to the next commit.
- –file-idle-time 0 How long before the file disappears from the video, 0 means never good for seeing the full file tree.
- –stop-at-end Stops the video at the end of all the commits.
- -b 000000 The background colour, in this case black.
- –output-ppm-stream – Tells gource to output the result ppm stream to STDOUT, which is then piped ( | ) into the ffmpeg
That is a quick overview of some of the gource arguments, running grouce -H in your terminal will print out the full list. I’m not going to go into the ffmpeg arguments because frankly I don’t understand them very well and video isn’t really my thing. I’m sure there are ffmpeg experts that would be able to do it better then what I have.
After running the above commands in my terminal window and letting it do its thing, I had a resulting mp4 file which I then uploaded to YouTube.
Below is the video that I uploaded to YouTube, which took about 5 hours due to my very very slow (read 138kb/s) upload speed. The video is about 8 years of QGIS development in just over 9 minutes.
As it’s a bit hard to see in the video due to the quality, each cluster of files is a directory and the branches show the folder hierarchy.
Direct link to video: http://www.youtube.com/watch?v=-NILKRiMtcU
Happy new year and happy coding
Filed under: Open Source, qgis Tagged: git, Gource, mapping, Open Source, qgis, Quantum GIS
One of the challenges in any open source project is accepting contributions from people that don’t have, need, or want access to your centralized source code repository. Managing repository accounts for occasional or one-time contributors can be come a bit of an administrative issue. To date, the QGIS project has accepted one-time or occasional contributions through patches submitted via a help ticket.
To make it easier for you to contribute to QGIS, we have created a clone of the Subversion repository on GitHub. This allows you to “fork” the QGIS repository and have your own local copy of the source code. Through GitHub you can easily submit your enhancements and bug fixes for inclusion in the Subversion repository.
You will need to install git on your computer and create a GitHub account. Once you have done that, here is the process for creating your working copy and contributing to QGIS:
- Login to GitHub
- Fork the project at https://github.com/qgis/qgis by clicking “Fork”. This may take a while
- Create a working copy, replacing g-sherman with your GitHub name:
git clone email@example.com:g-sherman/qgis.git
This will also take a while, depending on the speed of your network connection. My clone downloaded 162 Mb from GitHub.
- Change to the directory containing your local clone and add a reference to the original QGIS repo:
git remote add upstream git://github.com/qgis/qgis.git
This gives you are reference named upstream that points to the repo you forked.
- Now fetch from upstream:
git fetch upstream
- Now you are ready to work with QGIS. Make your changes, commit them, and then push back to your fork on GitHub:
git push origin master
- You can go to your repo on GitHub and you should see your commit message from the push
- Now you want to tell the QGIS developer team there is something they should look at. You do this by issuing a pull request by clicking on the “Pull Request” button on your GitHub QGIS fork page.
- Fill in a title and message for the request, review the commit(s) and file(s) involved and when satisfied, click “Send pull request”
- Now sit back and wait for someone to review, comment on, and hopefully merge your request into the QGIS repo.
To keep in sync with the QGIS repo, use
git fetch upstream
git merge upstream/master
Make sure to check out these resources for help and more information on working with repositories on GitHub:
Using Git with Subversion makes adding new features easy. Here are the metrics for my latest QGIS hack:
- SVN revisions by others while working on my branch: 177
- Time to complete merge with latest SVN revision: 1 second
- Conflicts: None
Coincidence? Maybe not.