Issue #16: Allow defining a target branch with a different name

Author: omarlopesino

.drupal-artifact-builder.yml.dist

@@ -1,6 +1,17 @@
+# repository
 # Repository URL (git SSH / git HTTP URL).
 repository: git@github.com:example/example-artifact.git
+
+# include
 # Extra files or folders to include into the artifact.
 include: []
+
+# author
 # It will be the author used in git commits.
-author: John Doe <passionate.developer@example.com>
+# author: John Doe <passionate.developer@example.com>
+
+# branch
+# Allow a source branch to be pushed to a specific target branch.
+# Use it only if you need push branches with a different branch name than the source.
+# branches_map:
+#  develop:develop-build

README.md

@@ -21,12 +21,39 @@ to have an starting point:
 cp vendor/metadrop/drupal-artifact-builder/.drupal-artifact-builder.yml.dist .drupal-artifact-builder.yml
 ```
 
-Configuration properties:
+#### Configuration properties
 
 - **repository**: Repository URL (git SSH / git HTTP URL).
-- **author**: It will be the author used in git commits.
+
+Example:
+```yaml
+repository: git@github.com:example/example-artifact.git
+```
+
 - **include**: Extra files or folders to include into the artifact.
 
+Example:
+```yaml
+include: []
+```
+
+- **author**: It will be the author used in git commits.
+
+Example:
+```yaml
+author: John Doe <passionate.developer@example.com>
+```
+
+- **branches_map**: Key value map to git push source artifact branches to different artifact branches.
+
+Example:
+```yaml
+branches_map:
+  develop:develop-build
+```
+
+This example will make push the artifacts coming from develop source branch to the develop-build artifact branch.
+
 ## Usage
 
 Builds the artifact and push the changes to git:

src/Config/Config.php

@@ -10,7 +10,7 @@
 class Config implements ConfigInterface {
 
   /**
-   * Branch where the artifact will be pushed.
+   * Branch where the artifact is created from.
    *
    * @var string
    */
@@ -25,11 +25,14 @@ class Config implements ConfigInterface {
    *   Extra files or folders included into the artifact.
    * @param string|null $author
    *   Artifact commit author.
+   * @param array|null $branches_map
+   *   Map between source and target branches.
    */
   public function __construct(
     protected ?string $repository = NULL,
     protected array $include = [],
     protected ?string $author = NULL,
+    protected array $branches_map = [],
   ) {
   }
 
@@ -80,7 +83,7 @@ public function setBranch(string $branch) : void {
    * @var string
    */
   public function getBranch() : string {
-    return $this->branch;
+    return $this->branches_map[$this->branch] ?? $this->branch;
   }
 
   /**
@@ -110,15 +113,25 @@ public static function createFromConfigurationFile(string $config_file) {
       'author',
     ];
 
-    if (isset($configuration['repository']) && !is_string($configuration['repository'])) {
-      throw new \InvalidArgumentException(sprintf('"repository" configuration key must be a string, %s given', gettype($configuration['repository'])));
+    foreach ($string_fields as $string_field) {
+      if (isset($configuration[$string_field]) && !is_string($configuration[$string_field])) {
+        throw new \InvalidArgumentException(sprintf('"%s" configuration key must be a string, %s given', $string_field, gettype($configuration['repository'])));
+      }
     }
 
-    if (isset($configuration['include']) && !is_array($configuration['include'])) {
-      throw new \InvalidArgumentException('"include" config key must be a string, %s given!');
+    $array_fields = [
+      'include',
+      'branches_map',
+    ];
+
+    foreach ($array_fields as $array_field) {
+      if (isset($configuration[$array_field]) && !is_array($configuration[$array_field])) {
+        throw new \InvalidArgumentException('"%s" config key must be a string, %s given!', $array_field, gettype($configuration[$array_field]));
+      }
     }
 
-    return new self($configuration['repository'] ?? NULL, $configuration['include'] ?? []);
+
+    return new self($configuration['repository'] ?? NULL, $configuration['include'] ?? [], $configuration['author'] ?? NULL, $configuration['branches_map'] ?? []);
   }
 
 }

src/Config/ConfigInterface.php

@@ -5,14 +5,22 @@
 interface ConfigInterface
 {
   /**
-   * Branch where the artifact will be created.
+   * Branch where artifact is pushed.
    *
-   * Its value will be set with the current branch.
+   * Default value: current branch.
    *
    * @var string
    */
   public function getBranch() : string;
 
+  /**
+   * Sets the branch where artifact is pushed.
+   *
+   * @param string $branch
+   *   Branch name.
+   */
+  public function setBranch(string $branch) : void;
+
   /**
    * Gets the repository where the commits will be pushed.
    *

src/DrupalArtifactBuilderGit.php

@@ -36,8 +36,10 @@ protected function initialize(InputInterface $input, OutputInterface $output) {
     if ($input->hasOption('repository') && !empty($input->getOption('repository'))) {
       $this->config->setRepository($input->getOption('repository'));
     }
-    $this->getConfiguration()->setBranch($this->getBranch($input));
-    $this->log(sprintf('Selected %s branch', $this->getConfiguration()->getBranch()));
+    $selected_branch = $this->getBranch($input);
+    $this->getConfiguration()->setBranch($selected_branch);
+    $this->log(sprintf('Source branch: %s', $selected_branch));
+    $this->log(sprintf('Target branch: %s', $this->getConfiguration()->getBranch()));
     $this->assertArtifactExists();
 
     if ($input->hasOption('author') && !empty($input->getOption('author'))) {