Skip to main content

Updating

How Updates Work​

When you create a project with SpeedPy, the install script sets up a speedpy Git remote and a speedpy branch. This branch tracks the upstream boilerplate so you can pull in updates.

Pulling Updates​

To update your project to the latest version of SpeedPy:

git fetch speedpy
git merge speedpy/master --allow-unrelated-histories

You may encounter merge conflicts if you've modified files that were also updated in the boilerplate. Resolve these conflicts as you would any Git merge.

After Updating​

After pulling updates, you should:

  1. Rebuild Docker images to pick up new dependencies:

    docker compose build

  2. Run migrations in case new models were added:

    docker compose run --rm web python manage.py migrate

  3. Install npm packages if package.json changed:

    docker compose run --rm web npm install

  4. Rebuild Tailwind CSS:

    docker compose run --rm web npm run tailwind:build

Tips​

  • Always commit your work before pulling updates so you have a clean state to revert to if needed.
  • Review the changelog or commit diff before merging to understand what changed.
  • Test your application after merging to catch any breaking changes.