Move dope.sh to top level
#531
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
infomiho
force-pushed
the
extract-dope-sh-to-top-level
branch
2 times, most recently
from
8c03552 to
1159ea4
Compare
3 tasks
infomiho
force-pushed
the
extract-dope-sh-to-top-level
branch
from
1159ea4 to
01c159c
Compare
cprecioso
approved these changes
Oct 8, 2025
opensaas-sh/README.md
Outdated
| brew install gpatch | ||
| brew install diffutils | ||
| ``` | ||
| For detailed information about the diff/patch workflow and MacOS setup requirements, see [../tools/README.md](../tools/README.md). |
There was a problem hiding this comment.
nitpick:
Suggested change
| For detailed information about the diff/patch workflow and MacOS setup requirements, see [../tools/README.md](../tools/README.md). | |
| For detailed information about the diff/patch workflow and macOS setup requirements, see [../tools/README.md](../tools/README.md). |
brand name is macOS 🤪
tools/README.md
Outdated
|
|
||
| ## dope.sh - Diff Or Patch Executor | ||
|
|
||
| The `dope.sh` script allows you to easily create a diff between two projects (base and derived), or to patch those diffs onto the base project to get the derived one. This is useful when a derived project has only small changes on top of the base project and you want to keep it in a directory in the same repo as the main project. |
There was a problem hiding this comment.
I'd add here a small sentence saying that having opensaas.sh be in sync with the template was the motivation for it.
tools/README.md
Outdated
|
|
||
| ### Workflow | ||
|
|
||
| Since derived apps (like opensaas-sh) are just the Open SaaS template with some small tweaks, and we want to keep them up to date as the template changes, we don't version the actual app code in git. Instead, we version the diffs between it and the template in an `app_diff/` directory. |
There was a problem hiding this comment.
Oh this thing here, I'd lift to the tool intro!
tools/README.md
Outdated
| ./dope.sh ../template app diff | ||
| ``` | ||
|
|
||
| ### Running on MacOS |
There was a problem hiding this comment.
IMO (feel free to disregard)
Suggested change
| ### Running on MacOS | |
| ### Requirements | |
| #### macOS |
Martinsos
reviewed
Oct 9, 2025
There was a problem hiding this comment.
Looking good to me from waht I saw, left some comments, but I see @cprecioso has grasp on it so I will let him give the approve and I will stay on the comment level and unsubscribe.
opensaas-sh/tools/diff.sh
Outdated
|
|
||
| TOOLS_DIR=$(dirname "$(realpath "$0")") # Assumes this script is in `tools/`. | ||
| cd "${TOOLS_DIR}" && cd ../.. | ||
| SCRIPT_DIR=$(dirname "$(realpath "$0")") # Assumes this script is in `opensaas-sh/tools/`. |
There was a problem hiding this comment.
This comment is not in the correct line anymore I think, I would move it to line below, since assumptions is happening there, with the "/../.."?
opensaas-sh/tools/patch.sh
Outdated
|
|
||
| TOOLS_DIR=$(dirname "$(realpath "$0")") # Assumes this script is in `tools/`. | ||
| cd "${TOOLS_DIR}" && cd ../.. | ||
| SCRIPT_DIR=$(dirname "$(realpath "$0")") # Assumes this script is in `opensaas-sh/tools/`. |
tools/README.md
Outdated
| @@ -0,0 +1,53 @@ | |||
| # Open SaaS Tools | |||
|
|
|||
| This directory contains utilities for managing derived projects that are built on top of the Open SaaS template. | |||
There was a problem hiding this comment.
Ha for now, it might contain any kind of tools :D! You could probably even leave this sentence out, maybe you don't need to at the moment "prescribe" what this "tools" dir is about.
raw
tools/README.md
Outdated
|
|
||
| ## dope.sh - Diff Or Patch Executor | ||
|
|
||
| The `dope.sh` script allows you to easily create a diff between two projects (base and derived), or to patch those diffs onto the base project to get the derived one. This is useful when a derived project has only small changes on top of the base project and you want to keep it in a directory in the same repo as the main project. |
tools/README.md
Outdated
|
|
||
| ### Workflow | ||
|
|
||
| Since derived apps (like opensaas-sh) are just the Open SaaS template with some small tweaks, and we want to keep them up to date as the template changes, we don't version the actual app code in git. Instead, we version the diffs between it and the template in an `app_diff/` directory. |
|
@cprecioso ready |
cprecioso
approved these changes
Oct 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Moves
dope.shto top level so it can be used with other apps, not onlyopensaas.sh. Prerequisite for #530*.copysupport todope.sh#525 to be merged and resolve any conflicts.Contributor Checklist