Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cooptilleuls/template-sync

Update projects started from a template with the latest changes made to the template
https://github.com/cooptilleuls/template-sync

template update-script

Last synced: about 1 month ago
JSON representation

Update projects started from a template with the latest changes made to the template

Awesome Lists containing this project

README 

        
# Template Sync



You started a project from a template repository but the template changed since you started the project?

Template Sync will import the changes made to the template to your project in a blink!



## Getting Started



```console

curl -sSL https://raw.githubusercontent.com/coopTilleuls/template-sync/main/template-sync.sh | sh -s -- 

```

If you have some conflicts, resolve them and run `git cherry-pick --continue`.



## Supported Templates



* [GitHub Templates](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)

* [GitLab Templates](https://docs.gitlab.com/ee/user/project/pages/getting_started/pages_new_project_template.html)

* [Symfony Docker](https://github.com/dunglas/symfony-docker)

* [API Platform Distribution](https://github.com/api-platform/api-platform)

* [Next.js starters](https://vercel.com/templates/next.js)



## How it works



This script identifies a commit in the template history which is the closest one to your project.

Then it squashes all the updates into a commit which will be cherry-picked on the top of your working branch.

Therefore you just have to resolve conflicts and work is done!



### Monorepo containing multiple templates



Using this kind of templates, you have to specify the subdirectory where your template is with

the `--directory` flag.



For example, assume you work on a project base on the template "api-routes" from next starters.

The main monorepo is vercel/next.js and the template is located in examples/api-routes :

```console

curl -sSL https://raw.githubusercontent.com/coopTilleuls/template-sync/main/template-sync.sh | sh -s -- https://github.com/vercel/next.js --directory=examples/api-routes

```



### Advanced



1. Go to your project repository (we recommend to create a new branch)

Copy template-sync.sh at the root of your project



2. The only mandatory argument is the GitHub or GitLab URL of your template but if you want to synchronize your project with a specific version of the template, you can specify the commit you are targeting by adding `--commit=`.

E.g. Assume your project is based on dunglas/symfony-docker and you just want to get the improvements of the new php app server [FrankenPHP](https://frankenphp.dev/). Run this command :

```console

curl -sSL https://raw.githubusercontent.com/coopTilleuls/template-sync/main/template-sync.sh | sh -s -- https://github.com/dunglas/symfony-docker --commit=88f5c19

```



3. In case some files are renamed or moved in the template history, you can modify the threshold where

git considers two files as identical. Default value for this script is 20% (git's default value is 50%).

If git is confused and considers files that are not identical to be identical, you can raise this threshold.

E.g:

```console

curl -sSL https://raw.githubusercontent.com/coopTilleuls/template-sync/main/template-sync.sh | sh -s --  --threshold=30

```



4. You can run the script in debug mode by adding the `--debug` flag.



5. If for any reason you are not satisfied with the result of the script you just have to run `git cherry-pick --abort` to rollback before the execution of the script.



*Created by [Emmanuel Barat](https://github.com/mano-lis) and [Raphael Marchese](https://github.com/Raphael-Marchese)*