Merge pull request #5 from gioxx/dev

gioxx · web-flow · commit 5ecd0d8dfc83 · 2025-05-23T17:50:23.000+02:00
A few new options to make the patch release more interesting 😃
diff --git a/.github/workflows/patch.yml b/.github/workflows/patch.yml
@@ -70,19 +70,33 @@ jobs:
         run: |
           OLD=${{ needs.check.outputs.old }}
           NEW=${{ needs.check.outputs.new }}
-          python YOURLS-diff_CreatePackage.py --old "$OLD" --new "$NEW"
+          python YOURLS-diff_CreatePackage.py --old "$OLD" --new "$NEW" --summary
+
         env:
           PYTHONUNBUFFERED: '1'
 
+      - name: Determine which artifacts to upload
+        id: build_artifacts
+        run: |
+          OLD=${{ needs.check.outputs.old }}
+          NEW=${{ needs.check.outputs.new }}
+          ARTIFACTS="YOURLS-update-$OLD-to-$NEW.zip YOURLS-update-$OLD-to-$NEW.txt"
+
+          if [ -f "YOURLS-update-$OLD-to-$NEW.removed.txt" ]; then
+            ARTIFACTS="$ARTIFACTS YOURLS-update-$OLD-to-$NEW.removed.txt"
+          fi
+
+          echo "artifact_files=$ARTIFACTS" >> $GITHUB_OUTPUT
+  
       - name: Create Release & Upload Patch
         uses: ncipollo/release-action@v1
         with:
           tag: ${{ needs.check.outputs.new }}
           name: "${{ needs.check.outputs.old }} to ${{ needs.check.outputs.new }}"
-          bodyFile: YOURLS-update-${{ needs.check.outputs.old }}-to-${{ needs.check.outputs.new }}.txt
+          bodyFile: YOURLS-update-${{ needs.check.outputs.old }}-to-${{ needs.check.outputs.new }}.summary.txt
           draft: false
           prerelease: false
-          artifacts: |
-            YOURLS-update-${{ needs.check.outputs.old }}-to-${{ needs.check.outputs.new }}.zip
+          artifacts: ${{ steps.build_artifacts.outputs.artifact_files }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+/venv
+/removed_backup
diff --git a/README.md b/README.md
@@ -2,17 +2,22 @@
 
 [Readme file is also available in italian](README_IT.md).
 
+![Patch Build](https://github.com/gioxx/YOURLS-diff/actions/workflows/patch.yml/badge.svg)
+
 **YOURLS Diff** is a Python script that simplifies updating a YOURLS installation via FTP by creating a ZIP package containing only the new or modified files between two release tags.
 
 If you want to take advantage of the patches that are automatically created by this script and this repository (via [this GitHub Action](.github/workflows/patch.yml)), you can take a look at [Releases](https://github.com/gioxx/YOURLS-diff/releases). The most recent update package will always be available by pointing to the [Latest tag](https://github.com/gioxx/YOURLS-diff/releases/latest). The script runs every day at midnight.
 
 ## Features
 
 - Automatically downloads the two ZIP archives (`old` and `new`) from the YOURLS GitHub repository.  
-- Compares files and identifies **new** or **modified** ones.  
+- Compares files and identifies **new**, **modified**, and **removed** files.  
 - Generates a ZIP package containing only the changed files.  
 - Produces an external manifest file (`.txt`) listing the changed files.  
-- Supports SSL certificate verification with an option to disable it.
+- Generates a `.removed.txt` file if any files were deleted.  
+- Creates a Bash deployment script (`.sh`) that allows you to update your YOURLS instance via rsync and SSH.  
+- Supports SSL certificate verification with an option to disable it.  
+- (Optional) Generates a WinSCP-compatible script (`.winscp.txt`) for Windows users to download and delete removed files via SFTP.
 
 ## Requirements
 
@@ -47,12 +52,15 @@ If you want to take advantage of the patches that are automatically created by t
 
 The main script is called `YOURLS-diff_CreatePackage.py` and accepts the following options:
 
-| Option         | Description                                                              | Example                              |
-|----------------|--------------------------------------------------------------------------|--------------------------------------|
-| `--old`        | **(required)** Tag of the starting release (e.g., `1.8.10`).             | `--old 1.8.10`                       |
-| `--new`        | Tag of the target release. If omitted, `latest` is used.                 | `--new 1.9.0`                        |
-| `--output`     | Output ZIP filename. Default: `YOURLS-update-OLD-to-NEW.zip`.            | `--output diff.zip`                  |
-| `--no-verify`  | Disable SSL certificate verification (not recommended).                  | `--no-verify`                        |
+| Option           | Description                                                                                        | Example                              |
+|------------------|----------------------------------------------------------------------------------------------------|--------------------------------------|
+| `--old`          | **(required)** Tag of the starting release (e.g., `1.8.10`).                                       | `--old 1.8.10`                       |
+| `--new`          | Tag of the target release. If omitted, `latest` is used.                                           | `--new 1.9.0`                        |
+| `--output`       | Output ZIP filename. Default: `YOURLS-update-OLD-to-NEW.zip`.                                      | `--output diff.zip`                  |
+| `--no-verify`    | Disable SSL certificate verification (not recommended).                                            | `--no-verify`                        |
+| `--summary`      | Generate a summary text file with patch details.                                                   | `--summary`                          |
+| `--only-removed` | Only generate the `.removed.txt` file (if any).<br>Also generates a deployment script to remove the files from the server. | `--only-removed` |
+| `--winscp`       | Generate a `.winscp.txt` script to download and delete the removed files (requires `--only-removed`). Useful for Windows users. | `--winscp` |
 
 ### Examples
 
@@ -69,11 +77,33 @@ The main script is called `YOURLS-diff_CreatePackage.py` and accepts the followi
   python YOURLS-diff_CreatePackage.py --old 1.8.10 --new 1.9.0 --output update.zip
   ```
 
+- **Only generate the removed file list and the deletion script**:
+  ```bash
+  python YOURLS-diff_CreatePackage.py --old 1.8.10 --only-removed
+  ```
+
+- **Include WinSCP script for removed files**:
+  ```bash
+  python YOURLS-diff_CreatePackage.py --old 1.8.10 --only-removed --winscp
+  ```
+
 - **Disable SSL verification**:
   ```bash
   python YOURLS-diff_CreatePackage.py --old 1.8.10 --no-verify
   ```
 
+## Deployment Options
+
+Once a patch is generated, you can deploy it to your YOURLS server using:
+
+- `YOURLS-deploy-OLD-to-NEW.sh`: Bash script using rsync and ssh (for Unix/Linux users)
+- `YOURLS-update-OLD-to-NEW.winscp.txt`: WinSCP batch script for Windows users (with `--winscp`)
+- **Manual FTP upload**: Simply extract the ZIP file and upload its **contents** manually using any FTP/SFTP client (e.g., FileZilla, Cyberduck, WinSCP, Transmit).
+
+Each script or method will:
+- Upload new or modified files (standard mode)
+- Remove files no longer present in the target version (automated scripts only)
+
 ## Repository Structure
 
 ```text
diff --git a/README_IT.md b/README_IT.md
@@ -1,23 +1,28 @@
 # YOURLS Diff
 
-[Il file Readme è disponibile anche in inglese](README.md).
+[Il file README è disponibile anche in inglese](README.md).
 
-**YOURLS Diff** è uno script Python che semplifica l'aggiornamento di un'installazione YOURLS tramite FTP, creando un pacchetto ZIP con solo i file nuovi o modificati tra due tag di release.
+![Patch Build](https://github.com/gioxx/YOURLS-diff/actions/workflows/patch.yml/badge.svg)
 
-Se vuoi sfruttare le patch che vengono create automaticamente da questo script e questo repository (tramite [questa GitHub Action](.github/workflows/patch.yml)), puoi dare un'occhiata alle [Releases](https://github.com/gioxx/YOURLS-diff/releases). Il pacchetto di aggiornamento più recente sarà sempre disponibile puntando al [tag Latest](https://github.com/gioxx/YOURLS-diff/releases/latest). Lo script viene eseguito ogni giorno a mezzanotte. 
+**YOURLS Diff** è uno script Python che semplifica l'aggiornamento di un'installazione YOURLS via FTP creando un archivio ZIP contenente solo i file nuovi o modificati tra due tag di rilascio.
+
+Se vuoi approfittare delle patch create automaticamente da questo script e da questo repository (tramite [questa GitHub Action](.github/workflows/patch.yml)), puoi consultare la sezione [Releases](https://github.com/gioxx/YOURLS-diff/releases). Il pacchetto più recente sarà sempre disponibile tramite il [Latest tag](https://github.com/gioxx/YOURLS-diff/releases/latest). Lo script viene eseguito ogni giorno a mezzanotte.
 
 ## Caratteristiche
 
 - Scarica automaticamente i due archivi ZIP (`old` e `new`) dal repository GitHub di YOURLS.  
-- Confronta i file e individua quelli **nuovi** o **modificati**.  
-- Genera un pacchetto ZIP contenente solo i file differenziati.  
-- Produce un file manifest esterno (`.txt`) con l'elenco dei file cambiati.  
-- Supporta la verifica SSL con possibilità di disabilitarla tramite flag.
+- Confronta i file e identifica quelli **nuovi**, **modificati** e **rimossi**.  
+- Genera un pacchetto ZIP contenente solo i file modificati.  
+- Produce un file manifest esterno (`.txt`) con l'elenco dei file modificati.  
+- Genera un file `.removed.txt` se sono stati eliminati file nella nuova versione.  
+- Crea uno script di deploy Bash (`.sh`) per aggiornare l'istanza YOURLS tramite rsync e SSH.  
+- Supporta la verifica del certificato SSL con possibilità di disabilitarla.  
+- (Opzionale) Genera uno script compatibile con WinSCP (`.winscp.txt`) per utenti Windows che vogliono scaricare ed eliminare file via SFTP.
 
 ## Requisiti
 
 - Python **3.6+**  
-- Librerie Python elencate in `requirements.txt`:
+- Librerie Python indicate in `requirements.txt`:
   ```txt
   requests>=2.20.0
   urllib3>=1.25.0
@@ -45,45 +50,67 @@ Se vuoi sfruttare le patch che vengono create automaticamente da questo script e
 
 ## Utilizzo
 
-Lo script principale si chiama `YOURLS-diff_CreatePackage.py` e accetta i seguenti parametri:
+Lo script principale si chiama `YOURLS-diff_CreatePackage.py` e accetta le seguenti opzioni:
 
-| Opzione        | Descrizione                                                                 | Esempio                               |
-|----------------|-----------------------------------------------------------------------------|---------------------------------------|
-| `--old`        | **(obbligatorio)** Tag della release di partenza (es. `1.8.10`).            | `--old 1.8.10`                        |
-| `--new`        | Tag della release di destinazione. Se omesso, viene usato `latest`.          | `--new 1.9.0`                         |
-| `--output`     | Nome del file ZIP di output. Default: `YOURLS-update-OLD-to-NEW.zip`.       | `--output diff.zip`                   |
-| `--no-verify`  | Disabilita la verifica del certificato SSL. _Non_ raccomandato.             | `--no-verify`                         |
+| Opzione           | Descrizione                                                                                       | Esempio                              |
+|-------------------|----------------------------------------------------------------------------------------------------|--------------------------------------|
+| `--old`           | **(obbligatorio)** Tag della versione di partenza (es: `1.8.10`).                                  | `--old 1.8.10`                       |
+| `--new`           | Tag della versione di destinazione. Se omesso, viene usato `latest`.                              | `--new 1.9.0`                        |
+| `--output`        | Nome del file ZIP in uscita. Default: `YOURLS-update-OLD-to-NEW.zip`.                             | `--output diff.zip`                 |
+| `--no-verify`     | Disattiva la verifica SSL (non consigliato).                                                      | `--no-verify`                       |
+| `--summary`       | Genera un file `.summary.txt` con il riepilogo delle modifiche.                                   | `--summary`                         |
+| `--only-removed`  | Genera solo il file `.removed.txt` (se ci sono file eliminati).<br>Genera anche lo script di rimozione remoto (`.sh`). | `--only-removed` |
+| `--winscp`        | Genera uno script `.winscp.txt` per scaricare ed eliminare i file rimossi (richiede `--only-removed`). Utile per utenti Windows. | `--winscp` |
 
-### Esempi di esecuzione
+### Esempi
 
-- **Aggiornare da 1.8.10 all'ultima release**:
+- **Aggiornare dalla 1.8.10 all'ultima versione disponibile**:
   ```bash
   python YOURLS-diff_CreatePackage.py --old 1.8.10
   ```
-  Genera:
-  - `YOURLS-update-1.8.10-to-<latest>.zip`  
-  - `YOURLS-update-1.8.10-to-<latest>.txt` (manifest)
 
-- **Aggiornare da 1.8.10 a 1.9.0 e nome personalizzato**:
+- **Aggiornare dalla 1.8.10 alla 1.9.0 con nome ZIP personalizzato**:
   ```bash
   python YOURLS-diff_CreatePackage.py --old 1.8.10 --new 1.9.0 --output update.zip
   ```
 
-- **Disabilitare la verifica SSL**:
+- **Generare solo la lista dei file rimossi e lo script di rimozione**:
+  ```bash
+  python YOURLS-diff_CreatePackage.py --old 1.8.10 --only-removed
+  ```
+
+- **Includere anche lo script WinSCP per la cancellazione remota**:
+  ```bash
+  python YOURLS-diff_CreatePackage.py --old 1.8.10 --only-removed --winscp
+  ```
+
+- **Disabilitare la verifica del certificato SSL**:
   ```bash
   python YOURLS-diff_CreatePackage.py --old 1.8.10 --no-verify
   ```
 
+## Opzioni di Deploy
+
+Una volta generato il pacchetto, puoi effettuare il deploy sulla tua installazione YOURLS usando:
+
+- `YOURLS-deploy-OLD-to-NEW.sh`: script Bash con rsync e ssh (per utenti Unix/Linux)
+- `YOURLS-update-OLD-to-NEW.winscp.txt`: script batch per WinSCP (Windows, con `--winscp`)
+- **Upload manuale via FTP**: Estrai il contenuto del file ZIP e caricalo manualmente utilizzando qualsiasi client FTP/SFTP (es: FileZilla, Cyberduck, WinSCP, Transmit).
+
+Ogni metodo/script ti consente di:
+- Caricare i file modificati o aggiunti (in modalità standard)
+- Rimuovere i file non più presenti nella nuova versione (solo con script automatici)
+
 ## Struttura del repository
 
 ```text
 ├── YOURLS-diff_CreatePackage.py   # Script Python principale
 ├── requirements.txt               # Dipendenze Python
-├── LICENSE                        # La licenza utilizzata per questo repository
-├── README.md                      # Questa documentazione, in inglese
-└── README_IT.md                   # Questa documentazione
+├── LICENSE                        # Licenza del progetto
+├── README.md                      # Documentazione in inglese
+└── README_IT.md                   # Documentazione in italiano
 ```
 
 ## Contribuire
 
-Pull request e segnalazioni di issue sono benvenute! Per favore apri una nuova issue per bug o feature request.
+Sono ben accetti Pull Request e segnalazioni di bug! Apri una issue per segnalazioni o proposte di nuove funzionalità.
diff --git a/YOURLS-diff_CreatePackage.py b/YOURLS-diff_CreatePackage.py
