highperfocused/open-saas
1
0
Fork 0
mirror of https://github.com/wasp-lang/open-saas.git synced 2025-04-10 04:49:03 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update updating-opensaas.md

Browse Source
This commit is contained in:
vincanger 2025-04-02 14:23:54 +02:00
parent 8ddb586652
commit 0d0bc76373
1 changed files with 43 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
opensaas-sh/blog/src/content/docs/guides/updating-opensaas.md
View File

@ -1,29 +1,65 @@
---
title: Updating your Open SaaS Template
title: How (Not) to Update Your Open SaaS App
banner:
content: |
Have an Open SaaS app in production? <a href="https://e44cy1h4s0q.typeform.com/to/EPJCwsMi">We'll send you some swag! 👕</a>
---
This guide will help you merge the latest changes from the Open SaaS template into your app.
:::danger[We advise against merging the latest template changes into your app]
If you've already started building your app, we generally advise against merging the latest template changes into your app.
## Initial Considerations
Below we outline our reasoning why, and provide a basic guide to help you update your app if you decide to do so anyway.
:::
It's not recommended that you merge the latest changes from the template into your app as you would in a typical monorepo setup.
Instead, we recommend that you [cherry-pick the commits](#cherry-picking-git-commits) that you want to merge and deal with any merge conflicts on a case-by-case basis. Or if your app has diverged significantly, you should [manually merge the changes](#manually-merging-changes).
## Why you probably shouldn't include the latest template changes in your app
:::caution
We generally **advise against updating your Open SaaS-based applications** after initial setup.
Why?
Because your codebase will naturally diverge from the template as you build your unique application, and any updates we may make to the template may not be compatible with your modified codebase, or your version of Wasp.
Even if you *really* want to include a new feature from the template in your app, proceed with caution and througly consider the following:
- Changes to the template may be tightly coupled. Implementing one change without related ones could cause unexpected issues.
- Updates might not be compatible with your version of Wasp.
- The more your codebase has diverged, the more challenging the update will be.
- We use a tagging system to keep template and Wasp versions in sync. This can make it difficult for you to pin down the exact commit hash of the template you started with.
## If you still decide to update your app
If you read above, considered the risks, and still need specific improvements, we recommend that you either:
1. Recomended: [Manually merge the changes](#manually-merging-changes).
2. Riskier/Advanced: [Cherry-pick the commits](#cherry-picking-git-commits) that you want to merge and deal with any merge conflicts on a case-by-case basis.
:::caution[Difficulties finding the correct commit hash]
Open SaaS uses a tagging system in order to give you a version of the template that works for the version of Wasp you're using.
For example, if you're using Wasp `v0.16.x`, it will pull the template at the commit hash with the tag `wasp-v0.16-template`.
If we make important changes to the template we may update the tag to a newer commit, so that new users will get the latest changes. That means that a tag, e.g. `wasp-v0.16-template`, may point to different commits over time, as changes are made to the template.
When updating your app, make sure you check the commit history on the `main` branch of the Open SaaS repo to find the correct commit hash that matches the code you started with.
This may make it difficult to find the correct commit hash that matches the template code you started with.
:::
## Manually merging changes
Compare your starting revision with the latest. You can find the commit hash of your starting revision in the [Open Saas GitHub repo's `main` branch](https://github.com/wasp-lang/open-saas/commits/main/).
Once you've copied the commit hash, you can use it to compare with the latest commit hash:
```bash
https://github.com/wasp-lang/open-saas/compare/<your-starting-commit-hash>..<latest-commit-hash>
```
For example, if your starting commit hash is `4c106fd` and the latest commit hash is `576d47a`, you can use the following URL:
[https://github.com/wasp-lang/open-saas/compare/4c106fd..576d47a](https://github.com/wasp-lang/open-saas/compare/4c106fd..576d47a)
This will show you the changes between your starting revision and the latest.
Manually apply any changes you want into your local project.
## Cherry-picking git commits
Add the Open SaaS repo as a remote:
```bash
@ -43,18 +79,3 @@ git cherry-pick 4c106fd^..upstream/main
```
This will replay every subsequent commit excluding the specified starting point (remove the `^` to be inclusive). If your codebase has diverged significantly, you may have to resolve any merge commits, but once complete, you'll have all the latest changes in your local repo.
## Manually merging changes
Compare your starting revision with the latest. You can find the commit hash of your starting revision in the [Open Saas GitHub repo's `main` branch](https://github.com/wasp-lang/open-saas/commits/main/).
Once you've copied the commit hash, you can use it to compare with the latest commit hash:
```bash
https://github.com/wasp-lang/open-saas/compare/<your-starting-commit-hash>..<latest-commit-hash>
```
For example, if your starting commit hash is `4c106fd` and the latest commit hash is `576d47a`, you can use the following URL:
[https://github.com/wasp-lang/open-saas/compare/4c106fd..576d47a](https://github.com/wasp-lang/open-saas/compare/4c106fd..576d47a)
This will show you the changes between your starting revision and the latest.
Manually apply any changes you want into your local project.