Version Control for Scripters, Part 1
For my first post, I’d like to talk about version control, specifically for scripting.
Now, it’s common knowledge that a version control (VC) system is essential for any “real” programming project, but as a mostly solo scripter (I’m normally the only person who scripts in my team at work), I never thought about doing any VC for myself. But over the years, as I’ve created batch files, shell scripts, vbscripts and now powershell scripts, I’ve been looking at the benefits of VC. The most compelling reasons are below:
- The scripts are backed up on another server
- You can undo changes, look back at old versions, and compare differences between versions
- You have a record of what changed on each version, as well as when it changed
For the most part, I’ve always backed up my scripts, so that was less of a worry for me. I’ve also been using dropbox to store my scripts, so rolling back to previous versions was also fairly easy. However I’ve never been very good at documenting my changes, so this might force me to get better. Additionally, I found that if I set up a new ProjectLocker account for each company I worked for, I could keep all my scripts online and private, while still giving my colleagues access. Then when I leave, my colleagues can still have access to my scripts, as well as the history of changes made to them.
Below is how I set up version control for my scripts, specifically using ProjectLocker and Git with TortoiseGit.
- Download the TortoiseGit package relevant to your architecture (32 or 64 bit) and install it. The installation is fairly straightforward, so clicking Next a few times should be all that is needed. Make sure to leave the SSH client on TortoisePLink.
- Download Git for Windows and install. Again, not much customisation is required during installation. On the Adjusting your PATH environment page, I selected Run Git from the Windows Command prompt, however the default will be fine too.
- Sign up for a free account at ProjectLocker. Since you can only create 1 project with the free account, I call my initial project AllScripts. Make sure to choose Git as the Repository Type.
- After the account has been created, log into the portal, answer the survey questions and create your security question and answer.
- Run PuttyGen from under the TortoiseGit menu and generate a key. I prefer to enter my email address as the comment. Enter a password and save the private key to a secure location.
- Copy the public key from the PuttyGen window.
- Open the ProjectLocker portal home and select Manage Public Keys. Create a New key. Enter a name, your email as the username, and paste the SSH public key into the Key field. Save to finish.
- Go to User Home and copy the Git Location.
- On your PC, create a folder that you will use as the base for your scripts.
- Open the folder, right-click on a blank area and choose Git Clone…
- Paste the Git Location into the URL field.
- Tick Load Putty Key and browse to where you saved the ppk file.
- Click OK and enter the password.
- Accept the Putty key warning.
- You should get a confirmation that you have cloned an empty repository.
That’s the setup complete. Now all your scripts can be copied to the AllScripts folder, ready for synching with ProjectLocker. In my next post, I’ll talk about the process of adding, uploading and working with the VC system for your scripts.