Upgrade ColdFront to main branch from v1.1.6 Using Git

upgrade_coldfront.md

Git Remote setup:

• origin -> Your organization's Git repo for ColdFront
• upstream -> https://github.com/ubccr/coldfront.git

Git Branch setup:

• custom -> This is your default branch, containing your organization's ColdFront codebase
• main -> This branch tracks the main branch of the ColdFront project
• staged_upgrade -> This is based on your custom branch, used for resolving merge conflicts

Commands:

# let's assume you only have a `main` branch and a `custom` branch
git checkout main
# pull in the latest changes
git pull upstream main
git checkout custom
# make a new branch off of your `custom` branch
git checkout -b staged_upgrade
git merge main
# resolve any conflicts in your text editor
git commit -m "merge bring in latest changes"

Migrate your database to accomodate changes to models:

coldfront makemigrations --merge
coldfront migrate

Restart your server in your testing environment to confirm everything is working as expected. If everything looks good, merge your staged_upgrade branch into your default branch:

git checkout custom
git merge staged_upgrade
# update your remote
git push origin custom
git branch -d staged_upgrade

Your organization's ColdFront codebase should now have the latest updates from the upstream ColdFront project.

If you want to enable some of the newest ColdFront features, you may need to install newer packages:

pip install -r requirements.txt