Merge pull request #5 from alalkamys/feat/default-pr-target-branch

Feat: Default PR Target Branch to Repo Default Branch

Author: alalkamys

README.md

@@ -8,7 +8,7 @@
 
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 [![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/alalkamys/code-migration-assistant)](https://github.com/alalkamys/code-migration-assistant/issues)
-[![Version](https://img.shields.io/github/release/alalkamys/code-migration-assistant.svg)](https://github.com/alalkamys/code-migration-assistant/releases/)
+[![GitHub Release](https://img.shields.io/github/v/release/alalkamys/code-migration-assistant)](https://github.com/alalkamys/code-migration-assistant/releases/)
 
 `Code Migration Assistant` is a powerful tool designed to streamline and automate the process of code migration at scale. With its intuitive interface and robust features, it enables users to effortlessly search for and replace patterns across multiple repositories, saving time and ensuring consistency in codebases.
 
@@ -32,6 +32,8 @@ With `Code Migration Assistant` teams can accelerate the migration of code repos
     - [`replacements` (Optional)](#replacements-optional)
     - [`filesToExclude` (Optional)](#filestoexclude-optional)
   - [Environment Variables](#environment-variables)
+  - [⚔️ Developed By](#️-developed-by)
+  - [:book: Author](#book-author)
 <!--te-->
 
 ## Key Features
@@ -55,6 +57,7 @@ With `Code Migration Assistant`, developers and DevOps teams can efficiently man
 ## Requriements
 
 - [Git:][git] `Code Migration Assistant` relies on Git for cloning and interacting with repositories. Make sure Git is installed on your system and configured properly.
+- Python 3.6 or higher.
 - Access to Target Repositories: Ensure that you have appropriate access permissions to clone and modify the target repositories specified in the configuration file (`config.json`).
 - Environment Variables: Set up the required environment variables such as `AZURE_DEVOPS_PAT`, `GITHUB_TOKEN` and `GITHUB_ENTERPRISE_TOKEN` with the appropriate access permissions to authenticate with the respective SCM providers and raise pull requests.
 
@@ -232,7 +235,7 @@ Below is an explanation of each field in the configuration file:
 
   - For `azuredevops`:
 
-    - `targetRefName` (required): The name of the target branch of the pull request. (e.g `main` or `refs/heads/main`).
+    - `targetRefName` (optional): The name of the target branch of the pull request. (e.g `main` or `refs/heads/main`). Defaults to the remote repository default branch.
     - `title` (required): The title of the pull request.
     - `description` (optional): The description of the pull request.
     - `labels` (optional): Labels to be applied to the pull request.
@@ -244,7 +247,7 @@ Below is an explanation of each field in the configuration file:
 
   - For `github`:
 
-    - `base` (required): The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository (e.g `main` or `refs/heads/main`).
+    - `base` (optional): The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository (e.g `main` or `refs/heads/main`). Defaults to the remote repository default branch.
     - `title` (required): The title of the pull request.
     - `body` (optional): The body content of the pull request.
     - `maintainer_can_modify` (optional): Indicates whether maintainers can modify the pull request.
@@ -294,6 +297,20 @@ Below is an explanation of each field in the configuration file:
 | `GITHUB_ENTERPRISE_TOKEN`                              | GitHub Enterprise Personal Access Token (PAT)                             | `None`                               |
 | `CODE_MIGRATION_ASSISTANT_USER_AGENT`                  | User agent used for HTTP requests by Code Migration Assistant             | `alalkamys/code-migration-assistant` |
 
+<br />
+
+## ⚔️ Developed By
+
+<a href="https://www.linkedin.com/in/shehab-el-deen/" target="_blank"><img alt="LinkedIn" align="right" title="LinkedIn" height="24" width="24" src="docs/assets/imgs/linkedin.png"></a>
+
+Shehab El-Deen Alalkamy
+
+<br />
+
+## :book: Author
+
+Shehab El-Deen Alalkamy
+
 <!--*********************  R E F E R E N C E S  *********************-->
 
 <!-- * Links * -->

app/helpers/scm_providers_operations.py

@@ -1,6 +1,7 @@
 from app.config import app_config
 from app.helpers import azuredevops
 from app.helpers import github
+from app.helpers.git import get_default_branch_name
 
 from azure.devops.credentials import BasicAuthentication
 from azure.devops.v7_0.git import GitPullRequest
@@ -51,7 +52,14 @@ def is_open_pull_requests(repo: Repo, pull_request_config: dict[str, dict[str, A
 
             source_ref_name = f"refs/heads/{
                 repo.active_branch.name}"
-            target_ref_name: str = pull_request_payload['targetRefName']
+            target_ref_name: str = pull_request_payload.get(
+                'targetRefName', None)
+
+            if not target_ref_name:
+                default_branch_name = get_default_branch_name(repo=repo)
+                _logger.info(f"Setting targetRefName to the default branch '{
+                             default_branch_name}'")
+                target_ref_name = default_branch_name
 
             if not target_ref_name.startswith("refs/heads/"):
                 _logger.debug(
@@ -104,7 +112,13 @@ def is_open_pull_requests(repo: Repo, pull_request_config: dict[str, dict[str, A
 
             head_ref = f"refs/heads/{
                 repo.active_branch.name}"
-            base_ref: str = pull_request_payload['base']
+            base_ref: str = pull_request_payload.get('base', None)
+
+            if not base_ref:
+                default_branch_name = get_default_branch_name(repo=repo)
+                _logger.info(f"Setting base to the default branch '{
+                             default_branch_name}'")
+                base_ref = default_branch_name
 
             if not base_ref.startswith("refs/heads/"):
                 _logger.debug(
@@ -214,7 +228,14 @@ def raise_pull_request(repo: Repo, pull_request_config: dict[str, dict[str, Any]
                 pull_request_payload.get('description', []))
             pull_request_payload['sourceRefName'] = f"refs/heads/{
                 repo.active_branch.name}"
-            target_ref_name: str = pull_request_payload['targetRefName']
+            target_ref_name: str = pull_request_payload.get(
+                'targetRefName', None)
+
+            if not target_ref_name:
+                default_branch_name = get_default_branch_name(repo=repo)
+                _logger.info(f"Setting targetRefName to the default branch '{
+                             default_branch_name}'")
+                target_ref_name = default_branch_name
 
             if not target_ref_name.startswith("refs/heads/"):
                 _logger.debug(
@@ -257,7 +278,13 @@ def raise_pull_request(repo: Repo, pull_request_config: dict[str, dict[str, Any]
                 pull_request_payload.get('body', []))
             pull_request_payload['head'] = f"refs/heads/{
                 repo.active_branch.name}"
-            base_ref: str = pull_request_payload['base']
+            base_ref: str = pull_request_payload.get('base', None)
+
+            if not base_ref:
+                default_branch_name = get_default_branch_name(repo=repo)
+                _logger.info(f"Setting base to the default branch '{
+                             default_branch_name}'")
+                base_ref = default_branch_name
 
             if not base_ref.startswith("refs/heads/"):
                 _logger.debug(