QT/InvoiceShelf
1
0
Fork 0
mirror of https://github.com/InvoiceShelf/InvoiceShelf.git synced 2026-05-25 12:44:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Replace deleted_files with manifest-based updater cleanup, add release workflow

Browse Source 
- Add manifest.json generation script (scripts/generate-manifest.php)
- Add Updater::cleanStaleFiles() that removes files not in manifest
- Add /api/v1/update/clean endpoint with backward compatibility
- Add configurable update_protected_paths in config/invoiceshelf.php
- Update frontend to use clean step instead of delete step
- Add GitHub Actions release workflow triggered on version tags
- Add .github/release.yml for auto-generated changelog categories
- Update Makefile to include manifest generation and scripts directory
This commit is contained in:
Darko Gjorgjijoski
2026-04-06 19:27:33 +02:00
parent 2bdfb6a8b6
commit e64529468c
12 changed files with 297 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
.github/release.yml vendored Normal file
View File

@@ -0,0 +1,18 @@
changelog:
categories:
- title: New Features
labels:
- enhancement
- feature
- title: Bug Fixes
labels:
- bug
- fix
- title: Maintenance
labels:
- chore
- dependencies
- ci
- title: Other Changes
labels:
- "*"

96
.github/workflows/release.yaml vendored Normal file
View File

@@ -0,0 +1,96 @@
name: Release
on:
push:
tags:
- "v*"
permissions:
contents: write
jobs:
release:
name: Build & Release
runs-on: ubuntu-latest
env:
extensions: bcmath, curl, dom, gd, imagick, json, libxml, mbstring, pcntl, pdo, pdo_mysql, zip
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: 8.4
extensions: ${{ env.extensions }}
tools: composer
- name: Install Composer dependencies
run: composer install --no-dev --optimize-autoloader --no-interaction
- name: Use Node.js 24
uses: actions/setup-node@v4
with:
node-version: 24
- name: Install npm dependencies
run: npm ci
- name: Build frontend
run: npm run build
- name: Prepare release directory
run: |
mkdir -p /tmp/InvoiceShelf/public
cp -r app /tmp/InvoiceShelf/
cp -r bootstrap /tmp/InvoiceShelf/
cp -r config /tmp/InvoiceShelf/
cp -r database /tmp/InvoiceShelf/
cp -r public/build /tmp/InvoiceShelf/public/
cp -r public/favicons /tmp/InvoiceShelf/public/
cp public/.htaccess /tmp/InvoiceShelf/public/
cp public/index.php /tmp/InvoiceShelf/public/
cp public/robots.txt /tmp/InvoiceShelf/public/
cp public/web.config /tmp/InvoiceShelf/public/
cp -r resources /tmp/InvoiceShelf/
cp -r lang /tmp/InvoiceShelf/
cp -r routes /tmp/InvoiceShelf/
cp -r storage /tmp/InvoiceShelf/
cp -r vendor /tmp/InvoiceShelf/ 2>/dev/null || true
cp -r scripts /tmp/InvoiceShelf/
cp version.md /tmp/InvoiceShelf/
cp .env.example /tmp/InvoiceShelf/
cp artisan /tmp/InvoiceShelf/
cp composer.json /tmp/InvoiceShelf/
cp composer.lock /tmp/InvoiceShelf/
cp LICENSE /tmp/InvoiceShelf/
cp readme.md /tmp/InvoiceShelf/
cp SECURITY.md /tmp/InvoiceShelf/
cp server.php /tmp/InvoiceShelf/
# Clean up runtime artifacts
find /tmp/InvoiceShelf -wholename '*/[Tt]ests/*' -delete
find /tmp/InvoiceShelf -wholename '*/[Tt]est/*' -delete
rm -rf /tmp/InvoiceShelf/storage/framework/cache/data/* 2>/dev/null || true
rm -f /tmp/InvoiceShelf/storage/framework/sessions/* 2>/dev/null || true
rm -f /tmp/InvoiceShelf/storage/framework/views/* 2>/dev/null || true
rm -f /tmp/InvoiceShelf/storage/logs/* 2>/dev/null || true
touch /tmp/InvoiceShelf/storage/logs/laravel.log
- name: Generate manifest
run: php scripts/generate-manifest.php /tmp/InvoiceShelf
- name: Create zip
working-directory: /tmp
run: zip -r InvoiceShelf.zip InvoiceShelf/
- name: Create GitHub Release
uses: softprops/action-gh-release@v2
with:
files: /tmp/InvoiceShelf.zip
generate_release_notes: true
make_latest: true

2
Makefile
View File

@@ -29,6 +29,7 @@ dist-gen: clean composer npm-build
@cp -r routes InvoiceShelf
@cp -r storage InvoiceShelf
@cp -r vendor InvoiceShelf 2> /dev/null || true
@cp -r scripts InvoiceShelf
@cp -r version.md InvoiceShelf
@cp -r .env.example InvoiceShelf
@cp -r artisan InvoiceShelf
@@ -47,6 +48,7 @@ dist-clean: dist-gen
@rm InvoiceShelf/storage/framework/sessions/* 2> /dev/null || true
@rm InvoiceShelf/storage/framework/views/* 2> /dev/null || true
@rm InvoiceShelf/storage/logs/* 2> /dev/null || true
@php scripts/generate-manifest.php InvoiceShelf
dist: dist-clean
@zip -r InvoiceShelf.zip InvoiceShelf

16
app/Http/Controllers/Admin/UpdateController.php
View File

@@ -66,14 +66,26 @@ class UpdateController extends Controller
}
public function delete(Request $request): JsonResponse
{
return $this->clean($request);
}
public function clean(Request $request): JsonResponse
{
$this->ensureSuperAdmin();
if (isset($request->deleted_files) && ! empty($request->deleted_files)) {
// Backward compatibility: use deleted_files when no manifest exists
if (! File::exists(base_path('manifest.json'))
&& isset($request->deleted_files)
&& ! empty($request->deleted_files)) {
Updater::deleteFiles($request->deleted_files);
return response()->json(['success' => true, 'cleaned' => 0]);
}
return response()->json(['success' => true]);
$result = Updater::cleanStaleFiles();
return response()->json($result);
}
public function migrate(Request $request): JsonResponse

74
app/Services/Update/Updater.php
View File

@@ -131,6 +131,80 @@ class Updater
return true;
}
public static function cleanStaleFiles(): array
{
$manifestPath = base_path('manifest.json');
if (! File::exists($manifestPath)) {
return ['success' => true, 'cleaned' => 0];
}
$manifest = json_decode(File::get($manifestPath), true);
if (! is_array($manifest)) {
return ['success' => false, 'error' => 'Invalid manifest'];
}
$manifestLookup = array_flip($manifest);
$protectedPaths = config('invoiceshelf.update_protected_paths', []);
$cleaned = 0;
$iterator = new \RecursiveIteratorIterator(
new \RecursiveDirectoryIterator(base_path(), \RecursiveDirectoryIterator::SKIP_DOTS),
\RecursiveIteratorIterator::CHILD_FIRST
);
foreach ($iterator as $file) {
$relativePath = substr($file->getPathname(), strlen(base_path()) + 1);
if (static::isProtectedPath($relativePath, $protectedPaths)) {
continue;
}
if ($file->isFile() && ! isset($manifestLookup[$relativePath])) {
File::delete($file->getPathname());
$cleaned++;
}
}
// Second pass: remove empty directories
$dirIterator = new \RecursiveIteratorIterator(
new \RecursiveDirectoryIterator(base_path(), \RecursiveDirectoryIterator::SKIP_DOTS),
\RecursiveIteratorIterator::CHILD_FIRST
);
foreach ($dirIterator as $item) {
if (! $item->isDir()) {
continue;
}
$relativePath = substr($item->getPathname(), strlen(base_path()) + 1);
if (static::isProtectedPath($relativePath, $protectedPaths)) {
continue;
}
$entries = scandir($item->getPathname());
if (count($entries) <= 2) {
@rmdir($item->getPathname());
}
}
return ['success' => true, 'cleaned' => $cleaned];
}
private static function isProtectedPath(string $relativePath, array $protectedPaths): bool
{
foreach ($protectedPaths as $protected) {
if ($relativePath === $protected || str_starts_with($relativePath, $protected.'/')) {
return true;
}
}
return false;
}
public static function migrateUpdate()
{
Artisan::call('migrate --force');

19
config/invoiceshelf.php
View File

@@ -46,6 +46,25 @@ return [
*/
'base_url' => 'https://invoiceshelf.com',
/*
* Paths protected from cleanup during updates.
* The updater will never delete files under these prefixes.
*/
'update_protected_paths' => [
'.env',
'storage',
'vendor',
'node_modules',
'Modules',
'public/storage',
'.git',
'bootstrap/cache',
'manifest.json',
'android',
'ios',
'mobile',
],
/*
* List of languages supported by InvoiceShelf.
*/

1
lang/en.json
View File

@@ -1366,6 +1366,7 @@
"unzipping_package": "Unzipping Package",
"copying_files": "Copying Files",
"deleting_files": "Deleting Unused files",
"cleaning_stale_files": "Cleaning stale files",
"running_migrations": "Running Migrations",
"finishing_update": "Finishing Update",
"update_failed": "Update Failed",

1
resources/scripts-v2/api/endpoints.ts
View File

@@ -153,6 +153,7 @@ export const API = {
UPDATE_UNZIP: '/api/v1/update/unzip',
UPDATE_COPY: '/api/v1/update/copy',
UPDATE_DELETE: '/api/v1/update/delete',
UPDATE_CLEAN: '/api/v1/update/clean',
UPDATE_MIGRATE: '/api/v1/update/migrate',
UPDATE_FINISH: '/api/v1/update/finish',

5
resources/scripts-v2/api/services/update.service.ts
View File

@@ -62,6 +62,11 @@ export const updateService = {
return data
},
async clean(payload?: { deleted_files?: string | string[] | null }): Promise<UpdateStepResponse> {
const { data } = await client.post(API.UPDATE_CLEAN, payload ?? {})
return data
},
async migrate(): Promise<UpdateStepResponse> {
const { data } = await client.post(API.UPDATE_MIGRATE)
return data

10
resources/scripts-v2/features/admin/views/settings/AdminUpdateAppView.vue
View File

@@ -14,7 +14,7 @@ type UpdateStepKey =
| 'download'
| 'unzip'
| 'copy'
| 'delete'
| 'clean'
| 'migrate'
| 'finish'
@@ -58,8 +58,8 @@ const updateSteps = ref<UpdateStep[]>([
time: null,
},
{
key: 'delete',
translationKey: 'settings.update_app.deleting_files',
key: 'clean',
translationKey: 'settings.update_app.cleaning_stale_files',
status: 'pending',
time: null,
},
@@ -202,8 +202,8 @@ async function startUpdate(): Promise<void> {
break
}
case 'delete':
await updateService.delete({
case 'clean':
await updateService.clean({
deleted_files: updateRelease.value.deleted_files ?? null,
})
break

1
routes/api.php
View File

@@ -434,6 +434,7 @@ Route::prefix('/v1')->group(function () {
Route::post('/update/unzip', [UpdateController::class, 'unzip']);
Route::post('/update/copy', [UpdateController::class, 'copy']);
Route::post('/update/delete', [UpdateController::class, 'delete']);
Route::post('/update/clean', [UpdateController::class, 'clean']);
Route::post('/update/migrate', [UpdateController::class, 'migrate']);
Route::post('/update/finish', [UpdateController::class, 'finish']);

61
scripts/generate-manifest.php Normal file
View File

@@ -0,0 +1,61 @@
<?php
/**
* Generate manifest.json for the InvoiceShelf updater.
*
* Usage: php scripts/generate-manifest.php [base-directory]
*
* Outputs a sorted JSON array of all relative file paths in the given
* directory. The manifest is written to {base-directory}/manifest.json
* and is used by the updater to detect and remove stale files after
* copying a new release.
*/
$basePath = rtrim($argv[1] ?? '.', '/');
if (! is_dir($basePath)) {
fwrite(STDERR, "Error: '{$basePath}' is not a directory.\n");
exit(1);
}
$excludedPrefixes = [
'.env',
'.git/',
'storage/',
'vendor/',
'node_modules/',
'Modules/',
'bootstrap/cache/',
'public/storage/',
];
$files = [];
$iterator = new RecursiveIteratorIterator(
new RecursiveDirectoryIterator($basePath, RecursiveDirectoryIterator::SKIP_DOTS),
RecursiveIteratorIterator::SELF_FIRST
);
foreach ($iterator as $file) {
if (! $file->isFile()) {
continue;
}
$relativePath = substr($file->getPathname(), strlen($basePath) + 1);
foreach ($excludedPrefixes as $prefix) {
if (str_starts_with($relativePath, $prefix)) {
continue 2;
}
}
$files[] = $relativePath;
}
sort($files);
$json = json_encode($files, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
file_put_contents($basePath.'/manifest.json', $json."\n");
$count = count($files);
fwrite(STDOUT, "manifest.json written with {$count} files.\n");