Difference between revisions of "Workflow"

From CSE330 Wiki
Jump to navigationJump to search
Line 243: Line 243:
=== SSH Access ===
=== SSH Access ===
You can configure Komodo Edit to connect to your EC2 instance.  '''This is not recommended or required for the purposes of CSE 330.'''  For the brave-hearted, instructions can be found here: [[Komodo Edit with SSH Access]]
You can configure Komodo Edit to connect to your EC2 instance (to implement option 1 in the flowchart above) However, because of a buggy and incomplete implementation in Komodo, '''this is not recommended or required for the purposes of CSE 330.'''  For the brave-hearted, instructions can be found here: [[Komodo Edit with SSH Access]]
== Starting a Project ==
== Starting a Project ==

Revision as of 06:56, 1 September 2013

The few minutes it takes to optimize your workflow will be the best few minutes you will spend in CSE 330 and your career. It is remarkable how many hours you can save just by using the best interface for text editing and deployment.


There are going to be several aspects to our workflow in CSE 330, and we will be switching between multiple different programs. Here is how they all fit together.

Running Commands

Mac OS X: You will be running commands on your local machine using Terminal, which you can find in your Applications -> Utilities folder. You will be connecting to your server via SSH also in Terminal.

Windows: You will be running commands on your local machine using Cygwin, which you will install in the next section. You will be connecting to your server via SSH also in Cygwin.

Version Control

You will be using SourceTree as a frontend to the Git version control system. Git enables you to keep track of changes to your source code, and also push your changes up to the CEC.

Text Editing

You will be using Komodo Edit as your text editing tool. Komodo Edit will also enable you to upload files to your Amazon cloud instance.


If you are more visual, this flowchart might help:


The flowchart illustrates 3 methods to copy files to your cloud instance: via your text editor, via an external SFTP client, and by cloning your remote Git repository. We will be primarily using Option 2 in CSE 330 this semester.

In the flowchart, your Git Client is SourceTree and your Text Editor is Komodo. The SFTP Client could be FileZilla.


Cygwin is a Linux Terminal emulator for Windows.

Mac OS X users do not need to install Cygwin since OS X itself is a derivative of Unix, which is an ancestor of Linux. The Terminal utility is all you need.


The CEC lab machines already have Cygwin installed. Follow these instructions to get Cygwin up and running on your personal PC.

  1. Run setup.exe from http://www.cygwin.com/
  2. Keep the Cygwin directory as the default, C:\cygwin. Choose a place like C:\cygwin\downloads to download the installation files. Choose any download site, although probably one with a .com suffix is best when you're in the US.
  3. In the "Select Packages" screen, select the following packages:
    • Net -> openssh
    • Net -> openssl
    • Python -> python (you will need this for Module 4)
    • One or more of the following:
      • Editors -> vim
      • Editors -> emacs
      • Editors -> nano
  4. Allow the installation to complete.

Throughout the rest of this course, when we say to "open a terminal", if you are on Windows, we mean to "open Cygwin".

Thanks to our colleagues at Mines for some tips on configuring Cygwin and SSH.


SourceTree is a tool that enables you to perform version control using a graphical user interface. It is free and available for Windows 7+ and Mac OS X 10.6+.

SourceTree is available on the Mac App Store. Windows users (and OS X users who don't like the App Store) may install it from http://sourcetreeapp.com/


Git is a distributed version control system that enables you to track changes to your code and work with collaborators on the same code base. In CSE 132, you used Subversion (SVN), which is also version control system.

Git, like SVN, is a command-line tool. However, SourceTree enables you to use Git without having to pull up a Terminal window every time you need to perform an action.

In Module 5, you will learn more advanced techniques for using Git. However, for Modules 2-4, you will be using Git primarily as a method to push your changes to your remote repository.

Configuring Git/SourceTree

Once you install SourceTree, you need to tell it your name so that it knows how to tag changes you make.

  1. Open the SourceTree Preferences (SourceTree->Preferences on OS X or Tools->Options on Windows).
  2. Check the box that says "Allow SourceTree to modify your global Mercurial and Git configuration files".
  3. Enter your name and e-mail address.
    Note: This actually does the same thing as running git config --global user.name <NAME HERE> and git config --global user.email <EMAIL HERE> from the command line.
  4. Go to the "Git" tab, and make the following changes:
    • Uncheck "Use the staging area". You will learn about staging in Git in Module 5, but for Modules 2-4 we will skip the staging area.
    • Check "Disable SSL certificate validation". This is necessary for the git repos hosted in the CEC.
  5. Close the preferences window.

Cloning a Repository

Screenshot of cloning a repository in SourceTree

We will start by cloning a remote Git repository.

"Cloning" in Git is much like "checking out" in SVN: a remote copy of the repository is copied down to a local working directory. Word of Caution: Git uses the term "checkout" to mean something different (which you will learn in Module 5), so do not use the words "clone" and "checkout" interchangeably.

If you wanted to clone a repository on the command line, the command would be:

$ git clone git://www.example.com/url-of-repo destination-path

In SourceTree, go to File->New, enter the remote repository URL and the destination path, and press "Clone". The destination path is where you want the repository's files to be copied on your personal computer; the path should point to either an empty or a nonexistent directory on your personal computer. In the screenshot, I am cloning the repository for the Fedora Linux kernel.

The remote repository will now be cloned onto your personal computer and all ready to use.


Screenshot of committing to a repository in SourceTree

When you make changes to files or add new files, you need to commit them to your working repository. Note: When you "commit" something in SVN, it means that you are sending your changes to the remote repository. This is not the case in Git, as we will see shortly.

To prepare your commit, press the "Commit" button in the SourceTree toolbar. See the screenshot for an example.

Select the files you want to commit, and enter a commit message summarizing the changes you've made since your last commit. When you're ready, press "Commit".

The command line equivalent of this would be:

$ git add --all # adds untracked files to the repository and stages them for the commit
$ git commit -am "This is an example commit"

What happens now is that your changes are recorded in your own local working copy of the Git repository. The changes have not been saved in the remote repository. You need to do this by pushing them.


Git is different from SVN in that you can use it completely independently from a remote repository. Thus, in Git, you need to perform the "commit" and "push" steps separately.

After you perform a commit, you need to push your commit to your remote repository. To do this, press the "Push" button in SourceTree, and then press "OK". The command line equivalent is:

$ git push master # assuming your branch is still named the default "master"

Note: You do not need to push after every commit. You could have 4 or 5 commits before you actually perform the push. When you push, all commits will be pushed.


In SVN, if you want to download changes from your remote repository, you performed an update. In Git, you perform a pull.

Pulling is (usually) as simple as pressing the "Pull" button in SourceTree. The command line equivalent is:

$ git pull master

Note: If you want to download the changes from the remote repository but not overwrite your current working copy, you can perform a fetch instead.

Pageant and PuTTYgen: SSH Keys for Windows

Pageant is a Windows utility that enables applications like SourceTree and Komodo Edit (which we will install in the next step) to be able to use your SSH keys when authenticating on remote services (like your EC2 instance). PuTTYgen is a utility that converts SSH keys into a format that Pageant can understand.

Mac OS X and Linux users may skip this section.

Installing Pageant and PuTTYgen

Pageant and PuTTYgen both come bundled with SourceTree, so you do not need to install them separately. However, if you weren't using SourceTree, you could install them from: http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html

Using PuTTYgen

We will use PuTTYgen to convert our SSH keys into Pageant's format, *.ppk.

  1. Launch PuTTYgen. If you downloaded puttygen.exe, just open it; if you are using the SourceTree version, you can find it under the Tools menu:
  2. Inside PuTTYgen, click "Load" next to "Load an existing private key file". We want to load the private key we generated in the SSH guide using ssh-keygen. If you kept Cygwin's default file structure, you should be able to find the key at:
    C:\cygwin\home\<your name>\.ssh\id_rsa
    Note that you might need to choose "All Files (*.*)" in order to see the file.
  3. When the key gets loaded, click "Save private key"
    You may use a passphrase if you want, but it is not required for CSE 330
  4. Save the new file in a secure location where you will always be able to access it.
  5. Close PuTTYgen.

Using Pageant

To launch Pageant, either run pageant.exe or select it from the Tools menu in SourceTree:


The first time you launch pageant, it will ask you to select a key. Select the *.ppk file you saved in the previous section.

If you wish to add more keys to Pageant, right-click on its icon down in the start bar:


Adding Pageant as a Startup Item

If you are using your own computer, it may be convenient to add Pageant as a startup item so that you don't need to go into SourceTree and turn it on every time you reboot your computer.

  1. Download pageant.exe if you were using SourceTree
  2. Open your Startup Items folder, located at Start Menu -> All Programs -> Startup (right-click and say "Open")
  3. Right-click inside the folder and say "New -> Shortcut". For the location, enter:
    "C:\path\to\pageant.exe" "c:\path\to\key.ppk"
    This will cause Pageant to open and automatically load your key.
  4. Press "Next". Enter a name and press "Finish".

Thanks to the University of Alberta for this tip.


You can use SFTP from the command line, or you can use any GUI file transfer client. All FTP clients I have seen also support SFTP. One popular FTP client is Filezilla.

  1. Download and install FileZilla from http://filezilla-project.org/download.php?type=client
    If you are using a lab computer, you can save it to your H drive.
  2. When you launch FileZilla, go to Edit→Settings or FileZilla→Preferences, and go to the SFTP options (under Connection). Click "Add keyfile…", and choose the *.ppk file that you made earlier using Puttygen. (If you lost that file, you can choose your *.pem file, and FileZilla will convert it for you.)
    When finished, press OK (not the red ×) to save your changes.
  3. Back on the main FileZilla screen, there are four fields: Host, Username, Password, and Port. Fill them in as follows:
    • Hostname: sftp://ec2-xxx-xx-xx-xxx.compute-1.amazonaws.com/
    • Username: The username you created on your server.
    • Password: Since you are using a key, you may leave this blank.
      If you changed your SSH settings to allow password-based authentication, then you could put your password in here.
    • Port: 22
  4. Then click Quickconnect. If everything is configured correctly, FileZilla should log into your server.


On the left and right of the FileZilla window, you can drag files between your computer and your server. Thus, you can edit a file in a text editor like Notepad++ on your decktop, and then upload it to your server by simply dragging it from the left pane to the right pane in FileZilla.

Komodo Edit


This semester in CSE 330, we will be using Komodo Edit as our editor of choice. We chose this editor because:

  1. It is free for everyone.
  2. It runs on Windows, Mac OS X, and Linux.
  3. It supports all of the languages we will be using in this class.
  4. It has a decent amount tools like auto-completion that will speed up your workflow.


Komodo Edit is already installed on the CEC lab machines. If you prefer to use your personal computer, download it from the web site: http://www.activestate.com/komodo-edit

SSH Access

You can configure Komodo Edit to connect to your EC2 instance (to implement option 1 in the flowchart above) . However, because of a buggy and incomplete implementation in Komodo, this is not recommended or required for the purposes of CSE 330. For the brave-hearted, instructions can be found here: Komodo Edit with SSH Access

Starting a Project

Start a new Komodo Project whenever you start a new assignment.

  1. Choose a directory in your repository.
    • Individual Repos: Create a new directory at the base of your individual repo with a new Komodo Project each time you start a new individual assignment. Name the directory after the project you will be starting (e.g., fileshare).
    • Group Repos: You can save your Komodo Project in the base directory of your repository.
  2. In Komodo, choose Project -> New Project (or press shift-ctrl-N).
  3. Navigate to the directory you just created, enter a name for the project (e.g., FileShare.komodoproject), and press "Save".
  4. You should now see a window like this:
  5. Press ctrl-N (or cmd-N) to create a new file. Save it in your project. For example, you could create a page named index.html with the Quick and Easy Page Layout:

Tip: To change between files without using a mouse, press ctrl-PageUp and ctrl-PageDown (cmd instead of ctrl on OS X). Many computers without explicit PageUp and PageDown buttons bind them to fn-Up and fn-Down. For example, on a MacBook Pro, to change to the next tab, you would press three keys: fn+cmd+down.

When you are ready, use FileZilla to upload your files to your server via SFTP.