New status wip (#749)

Author: mooxbot

README.md

@@ -19,52 +19,44 @@ php artisan vendor:publish --tag="devlink-config"
 
 ```bash
 
-# Ignore all files in packages/ (including symlinks)
+# Devlink
+# ignore symlinks in packages/
 packages/*
-# Allow tracking of real directories inside packages/
 !packages/**/
-# Ensure empty directories can be committed
 !packages/*/.gitkeep
-# for windows
+# and for windows
 /packageslocal/*
 
 ```
 
 2. Configure your paths and packages in the `config/devlink.php` file and change the package path in the `.env` file, if needed (Windows users should set the `DEVLINK_PACKAGES_PATH` variable to `packageslocal`).
 
-3. When running `devlink:status`:
+3. When running `php init.php`
 
-    - Lists all packages that are currently devlinked
-    - Lists all packages that are configured but not devlinked
-    - Lists all packages that are not configured, but devlinked
-    - Shows the configuration and the deploy status of each package
+    - Creates a `.env` file from `.env.example`
+    - Copies `composer.json-deploy` to `composer.json`
+    - Runs `composer install`
 
-4. When running `devlink:link`:
+4. When running `devlink:status`:
+
+    - Shows the configuration and status of each package
+    - Shows the link status (Linked, Unlinked, Deployed)
+    - Shows the update status (Up-to-date, Outdated)
+
+5. When running `devlink:link`:
 
     - Creates the packages folder, if it does not exist
-    - Creates backup of original composer.json → composer.json.original
     - Creates symlinks for all configured packages
     - Updates composer.json with development configuration
     - Creates composer.json-deploy for production use
     - Asks to run `composer install`
     - Asks to run `php artisan optimize:clear`
     - Asks to run `php artisan queue:restart`
 
-5. When running `devlink:unlink`:
-
-    - Removes all symlinks
-    - Deletes the packages folder, if empty
-    - Creates a backup of composer.json to composer.json-backup
-    - Restores original composer.json from composer.json-original
-    - Asks to run `composer install`
-    - Asks to run `php artisan optimize:clear`
-    - Asks to run `php artisan queue:restart`
-
 6. When running `devlink:deploy`:
 
     - Removes all symlinks
     - Deletes the packages folder, if empty
-    - Creates a backup of composer.json to composer.json-backup
     - Restores production-ready composer.json from composer.json-deploy
     - Asks to run `composer install`
     - Asks to run `php artisan optimize:clear`
@@ -73,17 +65,9 @@ packages/*
 7. CI Safety Net - `deploy.sh`:
 
     - If composer.json-deploy exists in the repository:
-        - the script will restore it as composer.json
-        - rename composer.json-original to composer.json-backup
-        - Commit and push the change in GH action
-    - This ensures no development configuration reaches production
-
-## Changing branches
-
-If you need to change the branches for ANY of the involved repositories, you just need to run the command again, it will automatically update the symlinks for the current branch.
-
-> ⚠️ **Important**  
-> If you forget to run the command, when CHANGING BRANCHES ON ANY OF THE REPOS, you will surely run into a 500 error, that drives you nuts.
+        - Remove all symlinks from /packages
+        - rename composer.json-deploy to composer.json
+    - Commit and push the change in your GitHub Action
 
 ## Mac
 
@@ -93,7 +77,7 @@ Mac works out of the box. You can have local packages mixed with the symlinked p
 
 ## Windows
 
-On Windows there are most probably some issues with the symlinks. If you run into issues, you can either globally or project-wise disable the symlinks or do the following:
+On Windows there are most probably some issues with ignoring symlinks. If you run into issues, you can either globally or project-wise disable the symlinks or do the following:
 
 ```env
 DEVLINK_PACKAGES_PATH=packageslocal

ROADMAP.md

@@ -1,8 +1,13 @@
 # Roadmap
 
+This is the roadmap for the devlink package.
+
 ## Current tasks
 
--   [ ] Private packages are not yet handled (copied and wired with path)
--   [ ] Need to delete private packages in the link and unlink steps then
--   [ ] There is probably an unclear state, because we do not yet use `-backup` yet
--   [ ] For the shell script, we also need to check if `-original` and `-backup` are correct
+We are working on the following tasks from top to bottom. Please don't forget to update the roadmap when a task is completed.
+
+-   [ ] ... no open tasks at the moment ...
+
+## Ideas
+
+-   [ ] Deploy: new feature: last version for all packages instead of \*

config/devlink.json

@@ -21,6 +21,16 @@
 $public_base_path = env('DEVLINK_PUBLIC_PATH', '../moox/packages');
 $private_base_path = env('DEVLINK_PRIVATE_PATH', 'disabled');
 
+/*
+|--------------------------------------------------------------------------
+| Private Packages Repo URL
+|--------------------------------------------------------------------------
+|
+| The URL of the Moox package repository. Can be set in the .env file.
+|
+*/
+$private_repo_url = env('DEVLINK_PRIVATE_REPO_URL', 'https://pkg.moox.pro/');
+
 return [
 
     /*
@@ -53,201 +63,153 @@
         // Moox
         'audit' => [
             'active' => false,
-            'linked' => true,
             'path' => $public_base_path.'/audit',
             'type' => 'public',
-            'deploy' => true,
         ],
         'backup-server-ui' => [
             'active' => false,
-            'linked' => true,
             'path' => $public_base_path.'/backup-server-ui',
             'type' => 'public',
-            'deploy' => true,
         ],
         'builder' => [
             'active' => false,
-            'linked' => true,
             'path' => $public_base_path.'/builder',
             'type' => 'public',
-            'deploy' => false,
         ],
         'category' => [
             'active' => false,
-            'linked' => true,
             'path' => $public_base_path.'/category',
             'type' => 'public',
-            'deploy' => true,
         ],
         'core' => [
             'active' => false,
-            'linked' => true,
             'path' => $public_base_path.'/core',
             'type' => 'public',
-            'deploy' => true,
         ],
         'devlink' => [
             'active' => false,
             'linked' => false,
             'path' => $public_base_path.'/devlink',
             'type' => 'public',
-            'deploy' => false,
         ],
         'devops' => [
             'active' => false,
-            'linked' => true,
             'path' => $public_base_path.'/devops',
             'type' => 'public',
-            'deploy' => true,
         ],
         'expiry' => [
             'active' => false,
-            'linked' => true,
             'path' => $public_base_path.'/expiry',
             'type' => 'public',
-            'deploy' => true,
         ],
         'flags' => [
             'active' => false,
-            'linked' => true,
             'path' => $public_base_path.'/flags',
             'type' => 'public',
-            'deploy' => true,
         ],
         'jobs' => [
             'active' => false,
-            'linked' => true,
             'path' => $public_base_path.'/jobs',
             'type' => 'public',
-            'deploy' => true,
         ],
         'login-link' => [
             'active' => false,
-            'linked' => true,
             'path' => $public_base_path.'/login-link',
             'type' => 'public',
-            'deploy' => true,
         ],
         'notifications' => [
             'active' => false,
-            'linked' => true,
             'path' => $public_base_path.'/notifications',
             'type' => 'public',
-            'deploy' => true,
         ],
         'passkey' => [
             'active' => false,
-            'linked' => true,
             'path' => $public_base_path.'/passkey',
             'type' => 'public',
-            'deploy' => true,
         ],
         'press' => [
             'active' => false,
-            'linked' => true,
             'path' => $public_base_path.'/press',
             'type' => 'public',
-            'deploy' => true,
         ],
         'security' => [
             'active' => false,
-            'linked' => true,
             'path' => $public_base_path.'/security',
             'type' => 'public',
-            'deploy' => true,
         ],
         'sync' => [
             'active' => false,
-            'linked' => true,
             'path' => $public_base_path.'/sync',
             'type' => 'public',
-            'deploy' => true,
         ],
         'tag' => [
             'active' => false,
-            'linked' => true,
             'path' => $public_base_path.'/tag',
             'type' => 'public',
-            'deploy' => true,
         ],
         'trainings' => [
             'active' => false,
-            'linked' => true,
             'path' => $public_base_path.'/trainings',
             'type' => 'public',
-            'deploy' => true,
         ],
         'user' => [
             'active' => false,
-            'linked' => true,
             'path' => $public_base_path.'/user',
             'type' => 'public',
-            'deploy' => true,
         ],
         'user-device' => [
             'active' => false,
-            'linked' => true,
             'path' => $public_base_path.'/user-device',
             'type' => 'public',
-            'deploy' => true,
         ],
         'user-session' => [
             'active' => false,
-            'linked' => true,
             'path' => $public_base_path.'/user-session',
             'type' => 'public',
-            'deploy' => true,
         ],
 
         // Moox Pro
         'connect' => [
             'active' => false,
-            'linked' => true,
             'path' => $private_base_path.'/connect',
+            'repo_url' => $private_repo_url,
             'type' => 'private',
-            'deploy' => true,
         ],
         'creator' => [
             'active' => false,
-            'linked' => true,
             'path' => $private_base_path.'/creator',
+            'repo_url' => $private_repo_url,
             'type' => 'private',
-            'deploy' => false,
         ],
         'data' => [
             'active' => false,
-            'linked' => true,
             'path' => $private_base_path.'/data',
+            'repo_url' => $private_repo_url,
             'type' => 'private',
-            'deploy' => true,
         ],
         'localize' => [
             'active' => false,
-            'linked' => true,
             'path' => $private_base_path.'/localize',
+            'repo_url' => $private_repo_url,
             'type' => 'private',
-            'deploy' => true,
         ],
         'media' => [
             'active' => false,
-            'linked' => true,
             'path' => $private_base_path.'/media',
+            'repo_url' => $private_repo_url,
             'type' => 'private',
-            'deploy' => true,
         ],
         'page' => [
             'active' => false,
-            'linked' => true,
             'path' => $private_base_path.'/page',
+            'repo_url' => $private_repo_url,
             'type' => 'private',
-            'deploy' => true,
         ],
         'permission' => [
             'active' => false,
-            'linked' => true,
             'path' => $private_base_path.'/permission',
+            'repo_url' => $private_repo_url,
             'type' => 'private',
-            'deploy' => true,
         ],
     ],
 

config/devlink.php

@@ -1,12 +1,6 @@
 #!/bin/bash
 
 if [ -f "composer.json-deploy" ]; then
-    # Remove all symlinks from /packages
     find packages -type l -delete
-    # Remove the packages folder if empty
-    if [ -z "$(ls -A packages)" ]; then
-        rm packages
-    fi
     cp composer.json-deploy composer.json
-    composer install
 fi

deploy.sh

@@ -0,0 +1,23 @@
+<?php
+
+if (file_exists('.env')) {
+    echo "Error: .env file already exists.\n";
+    exit(1);
+}
+
+$env = file_get_contents('.env.example');
+
+if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
+    $env = str_replace('DEVLINK_PACKAGES_PATH=packages', 'DEVLINK_PACKAGES_PATH=packageslocal', $env);
+    if (strpos($env, 'DEVLINK_PACKAGES_PATH=packageslocal') === false) {
+        $env = $env."\nDEVLINK_PACKAGES_PATH=packageslocal";
+    }
+}
+
+file_put_contents('.env', $env);
+
+if (file_exists('composer.json-deploy')) {
+    copy('composer.json-deploy', 'composer.json');
+}
+
+exec('composer install');