mirror of
https://github.com/Bubberstation/Bubberstation.git
synced 2025-12-17 21:24:01 +00:00
bea83b2999
* Use portable Python for map merge hooks, other tools (#55658) * Add .dmm merge driver (#55699) This is kind of a prototype. It only fully handles a few situations, and doesn't produce particularly easy-to-read conflict markers when it fails. I hope that it can be useful at least some of the time, can be improved over time, and that the lessons learned can influence a future interactive GUI conflict resolver (integrated into StrongDMM?). In the worst case, one can fall back to the tried and true "manually re-do one side's changes" strategy. **Automatic use**: In `tools/hooks/`, run `Install.bat` **Manual use**, for Git GUIs that don't run merge drivers: while a merge is in progress, in `tools/mapmerge2/`, double-click `Resolve Map Conflicts.bat` This PR also removes the error-prone "Prepare Maps.bat" / "mapmerge.bat" workflow. Those who aren't using the hooks should instead use `Run Before Committing.bat` before committing. First-time contributors who opened a PR without map merging can be advised to run `I Forgot To Map Merge.bat`. * Fix loose double-quot in tradership_faction.dmm Co-authored-by: Tad Hardesty <tad@platymuus.com>
37 lines
1.6 KiB
Markdown
37 lines
1.6 KiB
Markdown
# Git Integration Hooks
|
|
|
|
This folder contains installable scripts for Git [hooks] and [merge drivers].
|
|
Use of these hooks and drivers is optional and they must be installed
|
|
explicitly before they take effect.
|
|
|
|
To install the current set of hooks, or update if new hooks are added, run
|
|
`Install.bat` (Windows) or `tools/hooks/install.sh` (Unix-like) as appropriate.
|
|
|
|
If your Git GUI does not support a given hook, there is usually a `.bat` file
|
|
or other script you can run instead - see the links below for details.
|
|
|
|
## Hooks
|
|
|
|
* **Pre-commit**: Runs [mapmerge2] to reduce the diff on any changed maps.
|
|
* **DMI merger**: Attempts to [fix icon conflicts] when performing a Git merge.
|
|
* **DMM merger**: Attempts to [fix map conflicts] when performing a Git merge.
|
|
|
|
## Adding New Hooks
|
|
|
|
New Git [hooks] may be added by creating a file named `<hook-name>.hook` in
|
|
this directory. Git determines what hooks are available and what their names
|
|
are.
|
|
|
|
New Git [merge drivers] may be added by adding a shell script named `<ext>.merge`
|
|
and updating `.gitattributes` in the root of the repository to include the line
|
|
`*.<ext> merge=<ext>`.
|
|
|
|
Adding or removing hooks or merge drivers requires running the install script
|
|
again, but modifying them does not. See existing `.hook` and `.merge` files for examples.
|
|
|
|
[hooks]: https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks
|
|
[merge drivers]: https://git-scm.com/docs/gitattributes#_performing_a_three_way_merge
|
|
[mapmerge2]: ../mapmerge2/README.md
|
|
[fix icon conflicts]: https://tgstation13.org/wiki/Resolving_icon_conflicts
|
|
[fix map conflicts]: https://tgstation13.org/wiki/Map_Merger
|