Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danielsan80/php-backport
A simple php backport module
https://github.com/danielsan80/php-backport
backport composer packagist
Last synced: 28 days ago
JSON representation
A simple php backport module
- Host: GitHub
- URL: https://github.com/danielsan80/php-backport
- Owner: danielsan80
- License: mit
- Created: 2019-03-07T10:40:27.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-03-29T10:48:37.000Z (almost 5 years ago)
- Last Synced: 2024-11-08T18:43:34.748Z (3 months ago)
- Topics: backport, composer, packagist
- Language: PHP
- Homepage: https://packagist.org/packages/dansan/php-backport
- Size: 20.5 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Backport
## Getting started
```
composer requre dansan/php-backport --dev
```
Write the `backport.php` file to backport the source dir.
```php
setDirsToPort([
__DIR__.'/../src',
])
->execute()
;
echo "DONE\n";
```
Move on a `*_bp` branch, launch the backport.php script, commit and push
```
git branch master_bp
git checkout master_bp
php bin/backport.php
git add .
git commit -m "backport"
git push origin master_bp
```
In composer.json of the project where you need a backported version of your module:
```
...
"require": {
...
"acme/my-module": "dev-master_bp@dev",
...
}
...
```
## Development
Per iniziare clonare e avviare il progetto, poi eseguire i test.
```
git clone
cd
./dc up -d
./dc enter
test
```
Prima di fare `./dc up -d` è meglio fare `cp .env.dist .env` e modificare il `.env`
opportunamente.
## Cos'è
Questo modulo serve a fare il backporting di alcune funzionalità di PHP 7.0 nel modulo in cui viene usato.
Questa necessità è nata quando dopo aver realizzato un modulo (che chiameremo `Gammma`) in PHP 7.2 ci siamo resi
conto che uno degli applicativi su cui dovevamo utilizzarlo (che chiameremo `Alpha`) dipendeva
al più da PHP 7.0.
Inoltre questa dipendenza passava per un modulo intermedio (che chiameremo `Beta`).
```puml
component Gamma
component Beta
component Alpha
Alpha ..> Beta
Beta ..> Gamma
Alpha ..> Gamma
```
Tra le opzioni che si presentavano c'erano:
- Migrare `Alpha` ad una versione più recente dipendente da PHP >=7.2
- Rinunciare alle funzionalità di PHP 7.2 in `Beta` e `Gamma`
- Mantenere le funzionalità di PHP 7.2 per tutti gli altri progetti ma scrivere uno script di backport
per `Beta` e `Gamma`
Si è scelta quest'ultima opzione perché meno invasiva e più controllable delle altre e, apparentemente,
anche più conveniente.
E' stata individuata la libreria [nikic/php-parser](https://github.com/nikic/PHP-Parser) che permette
di fare parsing del codice sorgente PHP ed intervenire sul suo AST attraverso la scrittura di visitor.
Così abbiamo potuto fare backporting delle funzionalità di PHP non supportate nella 7.0
(o meglio quelle utilizzate da noi in `Beta` e `Gamma`).
### Come si usa
L'idea è che lo sviluppo di `Beta` e `Gamma` continui come di norma sul branch `master`.
Una volta che i test sono verdi e si intende usare la nuova versione dei branch `master` di `Beta` e `Gamma` su `Alpha`
ci si sposta sul branch `master_bp` e si tenta il merge con `master`.
```
git checkout master_bp
git merge master
```
Generalmente si verificano dei conflitti.
Risolvere i conflitti accettando tutto quello che viene da `master`
> Con PHPStorm è sufficiente fare `Git -> Resolve Conflicts`, selezionare tutto
e `Accept Theirs`.
Si tratta di codice completamente derivato quindi si può anche eliminare `master_bp` e
ricrearlo da zero se c'è il dubbio che qualcosa non torni
```
git checkout master
git branch -D master_bp
git push -d origin master_bp
git checkout master_bp
```
Una volta risolti i conflitti o rigenerato il branch bisogna eseguire lo script di backport
```
php bin/backport.php
```
Lo script `bin/backport.php` è molto semplice e facile da modificare e capire perché utilizza il client
messo a disposizione da `Dan/Backport`. Ogni repo però deve definire il proprio `bin/backport.php`
Lo script blocca l'esecuzione se non ci si trova su un branch con il suffisso `_bp` per evitare di effettuare
backporting su `master` o su un feature branch o di sviluppo.
Ecco un esempio di come può essere configurato il `bin/backport.php` di `Beta`
```php
setProjectDir(__DIR__.'/..')
->setDirsToPort([
__DIR__.'/../src',
__DIR__.'/../tests'
])
->addComposerJsonReplacement('/"acme\/gamma": "[^@]+@dev"/', '"acme/gamma": "dev-master_bp@dev"')
->execute()
;
echo "DONE\n";
```
Questo script di backport fa il backporting della directory `src` e della directory `tests`,
poi aggiorna il composer.json facendo dipendere `Beta` dal branch master_bp di `Gamma` anziché da quello corrente.
Dopo aver effettuato il backport facciamo una `composer update`, lanciamo i test, facciamo commit e push.
```
composer update
test
git add .
git commit -m "backport"
git push origin master_bp
```
> Se abbiamo fatto backport di `Gamma` potrebbe essere necessario a questo punto spostarsi su `Beta`
ed eseguire la stessa procedura.
Ora sarà necessario fare `composer update` su `Alpha`.
Ricapitolando:
`Alpha` dipende da
- "php": "7.0"
- "acme/beta": "dev-master_bp@dev"
- "acme/gamma": "dev-master_bp@dev"
`Beta`
- in `master` dipende da:
- "php": ">=7.2"
- "acme/gamma": "dev-master@dev",
- mentre in `master_bp` dipende da:
- "php": ">=7.0"
- "acme/gamma": "dev-master_bp@dev",
`Gamma`
- in `master` dipende da:
- "php": ">=7.2"
- in `master_bp` dipende da:
- "php": ">=7.0"
e gli script di backport aiutano a tenere allineate queste dipendenze parallele.
### Credits
Thanks to [Matiux](https://github.com/matiux) for the Docker images used in the project