Merge pull request #9 from fd6130/patch

Add CLI argument for tag or branch

doc/getting-started.md

@@ -21,6 +21,9 @@ but you can pass any stage name as the argument of the deploy/rollback commands:
 # deploy the current application to the "prod" server(s)
 $ ./bin/console deploy
 
+# deploy the given branch or tag application to the "prod" server(s)
+$ ./bin/console deploy --branch-or-tag=main
+
 # deploy the current application to the "staging" server(s)
 $ ./bin/console deploy staging
 

src/Command/DeployCommand.php

@@ -45,6 +45,7 @@ protected function configure()
             ->setDescription('Deploys a Symfony application to one or more remote servers.')
             ->setHelp('...')
             ->addArgument('stage', InputArgument::OPTIONAL, 'The stage to deploy to ("production", "staging", etc.)', 'prod')
+            ->addArgument('branch-or-tag', InputArgument::OPTIONAL, 'Branch or tag you would like checked out')
             ->addOption('configuration', 'c', InputOption::VALUE_REQUIRED, 'Load configuration from the given file path')
             ->addOption('dry-run', null, InputOption::VALUE_NONE, 'Shows the commands to perform the deployment without actually executing them')
         ;

src/Configuration/DefaultConfiguration.php

@@ -38,6 +38,7 @@ final class DefaultConfiguration extends AbstractConfiguration
     private $keepReleases = 5;
     private $repositoryUrl;
     private $repositoryBranch = 'master';
+    private $passedBranchOrTag = false;
     private $remotePhpBinaryPath = 'php';
     private $updateRemoteComposerBinary = false;
     private $remoteComposerBinaryPath = '/usr/local/bin/composer';
@@ -66,11 +67,16 @@ final class DefaultConfiguration extends AbstractConfiguration
     private $sharedDirs = [];
     private $resetOpCacheFor;
 
-    public function __construct(string $localProjectDir)
+    public function __construct(string $localProjectDir, ?string $branchOrTag = null)
     {
         parent::__construct();
         $this->localProjectDir = $localProjectDir;
         $this->setDefaultConfiguration(Kernel::MAJOR_VERSION);
+
+        if (!empty($branchOrTag)) {
+            $this->repositoryBranch = $branchOrTag;
+            $this->passedBranchOrTag = true;
+        }
     }
 
     // this proxy method is needed because the autocompletion breaks
@@ -127,7 +133,9 @@ public function repositoryUrl(string $url): self
 
     public function repositoryBranch(string $branchName): self
     {
-        $this->repositoryBranch = $branchName;
+        if (false === $this->passedBranchOrTag) {
+            $this->repositoryBranch = $branchName;
+        }
 
         return $this;
     }

src/Deployer/AbstractDeployer.php

@@ -35,6 +35,8 @@ abstract class AbstractDeployer
     /** @var ConfigurationAdapter */
     private $config;
 
+    protected $branchOrTag;
+
     abstract public function getRequirements(): array;
 
     abstract public function deploy();
@@ -132,6 +134,7 @@ public function beforeFinishingRollback()
     public function initialize(Context $context): void
     {
         $this->context = $context;
+        $this->branchOrTag = $context->getInput()->getArgument('branch-or-tag');
         $this->logger = new Logger($context);
         $this->taskRunner = new TaskRunner($this->context->isDryRun(), $this->logger);
         $this->log('<h1>Initializing configuration</>');
@@ -169,6 +172,11 @@ final protected function runLocal(string $command): TaskCompleted
         return $this->taskRunner->run($task)[0];
     }
 
+    final protected function getBranchOrTag(): ?string
+    {
+        return $this->branchOrTag;
+    }
+
     /**
      * @return TaskCompleted[]
      */

src/Deployer/DefaultDeployer.php

@@ -27,7 +27,7 @@ abstract class DefaultDeployer extends AbstractDeployer
 
     public function getConfigBuilder(): DefaultConfiguration
     {
-        return new DefaultConfiguration($this->getContext()->getLocalProjectRootDir());
+        return new DefaultConfiguration($this->getContext()->getLocalProjectRootDir(), $this->getBranchOrTag());
     }
 
     public function getRequirements(): array
@@ -252,6 +252,11 @@ private function doGetcodeRevision(): string
         $this->log('<h2>Getting the revision ID of the code repository</>');
         $result = $this->runLocal(sprintf('git ls-remote %s %s', $this->getConfig(Option::repositoryUrl), $this->getConfig(Option::repositoryBranch)));
         $revision = explode("\t", $result->getTrimmedOutput())[0];
+
+        if (empty($revision)) {
+            throw new InvalidConfigurationException(sprintf('No revisions found for %s', $this->getConfig(Option::repositoryBranch)));
+        }
+
         if ($this->getContext()->isDryRun()) {
             $revision = '(the code revision)';
         }

src/Server/ServerRepository.php

@@ -17,7 +17,7 @@
  */
 class ServerRepository
 {
-    /** @var Server[] $servers */
+    /** @var Server[] */
     private $servers = [];
 
     public function __toString(): string

src/Task/Task.php

@@ -15,7 +15,7 @@
 
 class Task
 {
-    /** @var Server[] $servers */
+    /** @var Server[] */
     private $servers;
     private $shellCommand;
     private $envVars;