Merge pull request #1 from codenamephp/main

Initial release

Author: bastianschwarz

.idea/runConfigurations/All.xml

@@ -0,0 +1,5 @@
+# Changelog
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

CHANGELOG.md

@@ -8,8 +8,17 @@
 ![Packagist Downloads](https://img.shields.io/packagist/dt/codenamephp/deployer.flow)
 ![GitHub](https://img.shields.io/github/license/codenamephp/deployer.flow)
 
+## What is it?
+
+This package provides deployer task for the flow framework.
+
 ## Installation
 
 Easiest way is via composer. Just run `composer require codenamephp/deployer.flow` in your cli which should install the latest version for you.
 
-## Usage
+## Usage
+
+First you need to add the `flow:context` configuration to each host according to your context names.
+
+Then just use the provided tasks in your deployer file or extend the `\de\codenamephp\deployer\flow\task\AbstractFlowTask` and use the
+`\de\codenamephp\deployer\flow\command\factory\iFlowCommandFactory` to run commands.

README.md

@@ -13,8 +13,8 @@
   "prefer-stable": true,
   "require": {
     "php": "^8.1",
-    "codenamephp/deployer.base": "dev-main",
-    "codenamephp/deployer.command": "dev-main"
+    "codenamephp/deployer.base": "^1.0",
+    "codenamephp/deployer.command": "^1.0"
   },
   "autoload": {
     "psr-4": {
@@ -34,10 +34,10 @@
     "sort-packages": true
   },
   "scripts": {
-    "phpunit": "tools/phpunit.phar -c test/phpunit.dist.xml test/",
-    "psalm": "tools/psalm --threads=10 --long-progress",
-    "composer-unused": "tools/composer-unused --no-progress --no-interaction --profile",
-    "composer-require-checker": "tools/composer-require-checker --no-interaction",
+    "phpunit": "XDEBUG_MODE=coverage tools/phpunit.phar -c test/phpunit.dist.xml test/",
+    "psalm": "XDEBUG_MODE=off tools/psalm --threads=10 --long-progress",
+    "composer-unused": "XDEBUG_MODE=off tools/composer-unused --no-progress --no-interaction --profile",
+    "composer-require-checker": "XDEBUG_MODE=off tools/composer-require-checker --no-interaction",
     "infection": "XDEBUG_MODE=coverage tools/infection --min-msi=100 --min-covered-msi=100 --threads=4 --no-progress --show-mutations",
     "ci-all": [
       "@phpunit",

composer.json

@@ -2,7 +2,8 @@
 
 namespace de\codenamephp\deployer\flow\task;
 
-use de\codenamephp\deployer\base\task\iTask;
+use de\codenamephp\deployer\base\task\iTaskWithDescription;
+use de\codenamephp\deployer\base\task\iTaskWithName;
 use de\codenamephp\deployer\command\runner\iRunner;
 use de\codenamephp\deployer\command\runner\WithDeployerFunctions;
 use de\codenamephp\deployer\flow\command\factory\iFlowCommandFactory;
@@ -13,7 +14,7 @@
  *
  * The flow command is created with the command factory using the command and arguments and run using the command runner
  */
-abstract class AbstractFlowTask implements iTask {
+abstract class AbstractFlowTask implements iTaskWithName, iTaskWithDescription {
 
   public function __construct(public iFlowCommandFactory $commandFactory = new WithBinaryFromDeployer(), public iRunner $commandRunner = new WithDeployerFunctions()) { }
 

src/task/AbstractFlowTask.php

@@ -14,8 +14,10 @@
 final class Generic extends AbstractFlowTask {
 
   public function __construct(public string       $command,
+                              public string       $taskName,
     /** @var array<int,string> */
                               public array        $arguments = [],
+                              public string       $taskDescription = '',
                               iFlowCommandFactory $commandFactory = new WithBinaryFromDeployer(),
                               iRunner             $commandRunner = new WithDeployerFunctions()) {
     parent::__construct($commandFactory, $commandRunner);
@@ -28,4 +30,12 @@ public function getCommand() : string {
   public function getArguments() : array {
     return $this->arguments;
   }
+
+  public function getDescription() : string {
+    return $this->taskDescription;
+  }
+
+  public function getName() : string {
+    return $this->taskName;
+  }
 }

src/task/Generic.php

@@ -15,6 +15,8 @@
  */
 final class Flush extends AbstractFlowTask {
 
+  public const NAME = 'flow:cache:flush';
+
   public function __construct(public bool         $force = false,
                               iFlowCommandFactory $commandFactory = new WithBinaryFromDeployer(),
                               iRunner             $commandRunner = new WithDeployerFunctions()) {
@@ -28,4 +30,12 @@ public function getCommand() : string {
   public function getArguments() : array {
     return $this->force ? ['--force'] : [];
   }
+
+  public function getDescription() : string {
+    return 'Flushes all configured caches.';
+  }
+
+  public function getName() : string {
+    return self::NAME;
+  }
 }

src/task/cache/Flush.php

@@ -11,11 +11,21 @@
  */
 final class Warmup extends AbstractFlowTask {
 
+  public const NAME = 'flow:cache:warmup';
+
   public function getCommand() : string {
     return 'cache:warmup';
   }
 
   public function getArguments() : array {
     return [];
   }
+
+  public function getDescription() : string {
+    return 'Fills caches for the next request.';
+  }
+
+  public function getName() : string {
+    return self::NAME;
+  }
 }

src/task/cache/Warmup.php

@@ -11,11 +11,21 @@
  */
 final class Migrate extends AbstractFlowTask {
 
+  public const NAME = 'flow:doctrine:migrate';
+
   public function getCommand() : string {
     return 'doctrine:migrate';
   }
 
   public function getArguments() : array {
     return [];
   }
+
+  public function getDescription() : string {
+    return 'Runs the doctrine database migrations';
+  }
+
+  public function getName() : string {
+    return self::NAME;
+  }
 }

src/task/doctrine/Migrate.php

@@ -11,11 +11,21 @@
  */
 final class Publish extends AbstractFlowTask {
 
+  public const NAME = 'flow:resource:publish';
+
   public function getCommand() : string {
     return 'resource:publish';
   }
 
   public function getArguments() : array {
     return [];
   }
+
+  public function getDescription() : string {
+    return 'Publish the resources to the public directory.';
+  }
+
+  public function getName() : string {
+    return self::NAME;
+  }
 }