Dev Maintenance

Note: "We're in the middle of moving over to a git workflow. If you haven't yet moved over to git, see the old instructions. If you're looking to move over, first make sure you've finished Moving your Dreamwidth installation to use Github"

Updating the Dreamwidth code on your Dreamhack

Warning: VERY IMPORTANT: If you have custom changes that you have not committed or patched out, you want to do that first! This is very easy. Just use git stash to save your work before you start, and recover it after you're done.

It is best to shut your Apache instance down before doing the update process, to make sure that everything, especially scripts in cgi-bin/ are reloaded properly:

stop-apache

Okay. Let's say you've been running your Dreamwidth install and you want to pull down the latest and greatest in fixes. This is pretty easy.

You should be making all your changes on branches, leaving the main develop and master branches alone. If you have any changes, first save them:

   cd $LJHOME
   git stash

You will want to note what branch you are on. It will be starred when you run:

   git branch

Then grab updates from the development branch of Dreamwidth's repository:

   git checkout develop
   git pull dreamwidth

To restore your saved changes, get back to the branch you were on:

   git checkout BRANCH
   git stash pop

Repeat for dw-nonfree:

   cd $LJHOME/ext/dw-nonfree
   git stash

   # note what branch you are on
   git branch

   git checkout develop
   git pull

   git checkout BRANCH
   git stash pop

Update your database:

   # order of commands is important
   $LJHOME/bin/upgrading/update-db.pl -r -p --innodb
   $LJHOME/bin/upgrading/update-db.pl -r --cluster=all --innodb
   $LJHOME/bin/upgrading/texttool.pl load

Now you can restart Apache:

start-apache

Of course, in a production environment, this whole process is not too recommended as you never know what kind of code you're going to get. But for the most part, it's fairly straightforward. (And if you're doing development, this is generally safe.)

Additional Information for Non-Dreamhack Users

This section is only for you if you're running your own installation.

Instead of using start-apache/stop-apache, which are Dreamhack-specific scripts, use these commands:

   sudo /etc/init.d/apache2 start
   sudo /etc/init.d/apache2 stop 

You'll also want to update packages on your system at some point. On Ubuntu, this would be done using:

apt-get update
apt-get upgrade

Or, if you want an easy command to run on your dw account in one swoop:

sudo apt-get update && sudo apt-get upgrade

Scripting

Warning: "These scripts have not been throughly tested yet with the new system; they might not be updated entirely or right."

You can, of course, use scripts to make it easier for you to do most of this.

There is an "omnibus" script available at http://dw-dev.dreamwidth.org/94822.html which incorporates all the individual scripts listed here and some other functions, and includes help information.

Some simpler example scripts are given below.

dwu - Updating the repos

Put this code in a file called ~/bin/dwu and make it executable with chmod ugo+x ~/bin/dwu:

#!/bin/bash
oldpwd=$PWD && \
cd $LJHOME && \
git pull dreamwidth develop && \
cd $oldpwd

Now, when you type 'dwu', this script will update dw-free. If you need to update dw-nonfree as well, then use this code:

#!/bin/bash
oldpwd=$PWD && \
cd $LJHOME && \
git pull && \
cd $LJHOME/ext/dw-nonfree && \
git pull && \
cd $oldpwd

dwdb - Updating the database

Put this code in a file called ~/bin/dwdb and make it executable with chmod ugo+x ~/bin/dwdb:

#!/bin/bash
$LJHOME/bin/upgrading/update-db.pl -r -p --innodb && \
$LJHOME/bin/upgrading/update-db.pl -r --cluster=all --innodb && \
$LJHOME/bin/upgrading/texttool.pl load

This will update the database when you type 'dwdb'.

Cleaning up your directories

If you do any amount of work, you'll find that your directories get cluttered with .orig and .rej files everywhere. This script will clean those up:

git clean -f "*.rej" "*.orig"

You can run it from the command line, or put it in a file called ~/bin/tidy and make it executable with "chmod +x ~/bin/tidy". If you do that, you'll be able to just type "tidy" to clean house.