Chatbot Kit

Codebase Updates

Keeping your application synchronized with the latest Chatbot Kit features and improvements is achievable through Git operations.

However, it's important to understand that as your project evolves with custom modifications, integrating upstream changes becomes increasingly complex. The update process involves rebasing your customizations onto the newest Chatbot Kit foundation, which may require careful conflict resolution to preserve your unique implementations.

Prior to initiating any updates, ensure your working directory is in a clean state with all changes properly committed to avoid potential data loss.

Add Chatbot Kit repository as a remote

For successful updates, establish a connection to the original Chatbot Kit repository by configuring it as an upstream remote. Execute the following terminal command:

git remote add upstream https://github.com/Wawa-Sensei/chatbot-kit.git

This step can be omitted if you've previously configured the upstream remote during initial setup.

Update your repository from the Chatbot Kit repository

To incorporate the latest changes from the upstream repository, execute:

git pull upstream main --allow-unrelated-histories --rebase

Should merge conflicts arise during this process, manual intervention will be required to reconcile differences between your customizations and the upstream changes. For guidance on conflict resolution, consult the Git documentation.

Updating n8n Workflows

When new n8n workflow templates become available in Chatbot Kit updates, you'll need to import them into your n8n instance. Please note that importing workflows requires special attention to avoid overwriting your existing customizations.

Important Considerations

  • Name Conflicts: Importing workflows with identical names will overwrite your existing workflows completely
  • Selective Updates: Rather than importing all workflows, consider reviewing the changes and manually incorporating only the updates you need

How to Update Workflows

  1. Follow the workflow import process outlined in the Getting Started guide
  2. Before importing, rename your existing custom workflows to avoid conflicts (e.g., add a suffix like _custom or _backup)
  3. Import the new workflow templates from the Chatbot Kit repository
  4. Compare the new workflows with your custom versions
  5. Manually merge desired features from the updated workflows into your custom implementations
  6. Delete any unnecessary duplicate workflows after successful integration

This approach ensures you maintain your customizations while benefiting from the latest workflow improvements and features.