Pull Updates

Keeping your project up to date with the latest changes from the original SuperSaaS template requires merging updates while preserving your custom modifications. Follow these steps to safely integrate the latest changes.

Steps to Merge Updates

1. Add the Original Repository as a Remote

First, ensure the original SuperSaaS repository is added as a remote source:

# Add the original repository as a remote named "supersaas-origin"
git remote add supersaas-origin https://github.com/SupersaasHQ/essentials-v3.git

2. Fetch the Latest Changes

Retrieve the latest updates from the original repository:

# Fetch the latest changes from supersaas-origin
git fetch supersaas-origin

3. Create a Temporary Branch

Before merging, create a temporary branch to handle updates safely:

# Ensure you're on your main branch
git checkout main

# Create and switch to a new branch for the update
git checkout -b update-supersaas-origin

4. Merge the Changes

Merge the latest updates from the SuperSaaS repository into your temporary branch:

# Merge updates from supersaas-origin into your temporary branch
git pull supersaas-origin main --allow-unrelated-histories --no-rebase

5. Resolve Conflicts

Conflicts may arise if you've modified files that were also updated in the original repository. Manually resolve conflicts using an editor like VS Code:

Tip: The best way to resolve conflicts is to use VS Code’s built-in merge conflict tool.

6. Review and Test Changes

Before merging into your main branch, carefully review all changes:

• Ensure that your custom modifications are intact.
• Test your application thoroughly to prevent breaking changes.
• Use git diff main to see what has changed:

git diff main

7. Merge to Main

Once you've resolved conflicts and verified everything works, merge the updates into your main branch:

# Switch back to the main branch
git checkout main

# Merge the updates from the temporary branch
git merge update-supersaas-origin

# Push the changes to your repository
git push origin main

Final Notes

• Always create a backup or work in a separate branch before merging updates.
• Test thoroughly before deploying any changes.
• If you run into issues, reviewing Git logs and diffs can help debug problems.

By following these steps, you can keep your SuperSaaS-based project updated while maintaining your custom modifications.