Merge pull request #56 from saadmk11/add-pr-labels

[Feature] Add Option to Add Labels to Pull Requests

Author: saadmk11

README.md

@@ -93,6 +93,7 @@ These are the inputs that can be provided on the workflow.
 | `release_types`                      | No       | A comma separated string of release types to use when updating the actions. By default, all release types are used to update the actions. Only Applicable for **"release-tag", "release-commit-sha"** (**Options:** "major", "minor", "patch" **[one or many seperated by comma]**) | "all"                                          | "minor, patch"                             |
 | `pull_request_user_reviewers`        | No       | A comma separated string (usernames) which denotes the users that should be added as reviewers to the pull request                                                                                                                                                                  | `null`                                         | "octocat, hubot, other_user"               |
 | `pull_request_team_reviewers`        | No       | A comma separated string (team slugs) which denotes the teams that should be added as reviewers to the pull request                                                                                                                                                                 | `null`                                         | "justice-league, other_team"               |
+| `pull_request_labels`                | No       | A comma separated string (label names) which denotes the labels which will be added to the pull request                                                                                                                                                                             | `null`                                         | "dependencies, automated"               |
 | `extra_workflow_locations`           | No       | A comma separated string of file or directory paths to look for workflows. By default, only the workflow files in the `.github/workflows` directory are checked updates                                                                                                             | `null`                                         | "path/to/directory, path/to/workflow.yaml" |
 
 #### Workflow with all options
@@ -133,6 +134,7 @@ jobs:
           release_types: "minor, patch"
           pull_request_user_reviewers: "octocat, hubot, other_user"
           pull_request_team_reviewers: "justice-league, other_team"
+          pull_request_labels: "dependencies, automated"
           extra_workflow_locations: "path/to/directory, path/to/workflow.yaml"
           # [Experimental]
           pull_request_branch: "actions-update"

action.yaml

@@ -52,6 +52,10 @@ inputs:
     description: 'A comma separated string (team slugs) which denotes the teams that should be added as reviewers to the pull request'
     required: false
     default: ''
+  pull_request_labels:
+    description: 'A comma separated string (label names) which denotes the labels which will be added to the pull request'
+    required: false
+    default: ''
   extra_workflow_locations:
     description: 'A comma separated string of file or directory paths to look for workflows. By default, only the workflow files in the .github/workflows directory are checked updates'
     required: false

src/config.py

@@ -54,6 +54,7 @@ class Configuration(NamedTuple):
     update_version_with: str = LATEST_RELEASE_TAG
     pull_request_user_reviewers: set[str] = set()
     pull_request_team_reviewers: set[str] = set()
+    pull_request_labels: set[str] = set()
     release_types: list[str] = ALL_RELEASE_TYPES
     extra_workflow_paths: set[str] = set()
 
@@ -99,6 +100,7 @@ def get_user_config(cls, env: Mapping[str, str | None]) -> dict[str, str | None]
             "release_types": env.get("INPUT_RELEASE_TYPES"),
             "pull_request_user_reviewers": env.get("INPUT_PULL_REQUEST_USER_REVIEWERS"),
             "pull_request_team_reviewers": env.get("INPUT_PULL_REQUEST_TEAM_REVIEWERS"),
+            "pull_request_labels": env.get("INPUT_PULL_REQUEST_LABELS"),
             "extra_workflow_paths": env.get("INPUT_EXTRA_WORKFLOW_LOCATIONS"),
         }
         return user_config
@@ -148,6 +150,12 @@ def clean_pull_request_team_reviewers(value: Any) -> set[str] | None:
             return {s.strip() for s in value.strip().split(",") if s}
         return None
 
+    @staticmethod
+    def clean_pull_request_labels(value: Any) -> set[str] | None:
+        if value and isinstance(value, str):
+            return {s.strip() for s in value.strip().split(",") if s}
+        return None
+
     @staticmethod
     def clean_release_types(value: Any) -> list[str] | None:
         if value and isinstance(value, str):

src/main.py

@@ -29,6 +29,7 @@
 )
 from .utils import (
     add_git_diff_to_job_summary,
+    add_pull_request_labels,
     add_pull_request_reviewers,
     create_pull_request,
     display_whats_new,
@@ -104,6 +105,12 @@ def run(self) -> None:
                         self.user_config.pull_request_team_reviewers,
                         self.user_config.github_token,
                     )
+                    add_pull_request_labels(
+                        self.env.repository,
+                        pull_request_number,
+                        self.user_config.pull_request_labels,
+                        self.user_config.github_token,
+                    )
             else:
                 add_git_diff_to_job_summary()
                 gha_utils.error(

src/utils.py

@@ -104,6 +104,43 @@ def add_pull_request_reviewers(
         )
 
 
+def add_pull_request_labels(
+    repository_name: str,
+    pull_request_number: int,
+    labels: set[str],
+    github_token: str | None = None,
+) -> None:
+    """Request reviewers for a pull request on GitHub"""
+    with gha_utils.group(f"Add Labels to Pull Request #{pull_request_number}"):
+
+        if not labels:
+            gha_utils.echo("No labels to add.")
+            return
+
+        payload = {"labels": list(labels)}
+
+        url = (
+            f"https://github.com/__api/repos/{repository_name}/issues"
+            f"/{pull_request_number}/labels"
+        )
+
+        response = requests.post(
+            url, json=payload, headers=get_request_headers(github_token)
+        )
+
+        if response.status_code == 200:
+            gha_utils.notice(
+                f"Added '{labels}' labels to "
+                f"pull request #{pull_request_number} \U0001F389"
+            )
+            return
+
+        gha_utils.error(
+            f"Could not add labels to pull request #{pull_request_number} "
+            f"on {repository_name}, GitHub API Response: {response.json()}"
+        )
+
+
 def add_git_diff_to_job_summary() -> None:
     """Add git diff to job summary"""
     markdown_diff = (