Merge pull request #10 from saadmk11/remove-duplicate-comment-line

Remove duplicate changes from pull request body and improve code

Author: saadmk11

main.py

@@ -2,6 +2,7 @@
 import os
 import subprocess
 import time
+from functools import cached_property
 
 import requests
 import yaml
@@ -47,14 +48,32 @@ def get_ignored_actions(json_string):
             )
         return set()
 
+    @cached_property
+    def get_request_headers(self):
+        """Get headers for GitHub API request"""
+        headers = {
+            'Accept': 'application/vnd.github.v3+json'
+        }
+        # if the user adds `token` add it to API Request
+        # required for `private` repositories and creating pull requests
+        if self.token:
+            headers.update({
+                'authorization': 'Bearer {token}'.format(token=self.token)
+            })
+
+        return headers
+
     def run(self):
         """Entrypoint to the GitHub Action"""
         workflow_paths = self.get_workflow_paths()
-        comment = ''
+        pull_request_body = set()
 
         if not workflow_paths:
             print_message(
-                f'No Workflow found in "{self.repository}". Skipping GitHub Actions Version Update',
+                (
+                    f'No Workflow found in "{self.repository}". '
+                    f'Skipping GitHub Actions Version Update'
+                ),
                 message_type='warning'
             )
             return
@@ -65,7 +84,10 @@ def run(self):
         for workflow_path in workflow_paths:
             try:
                 with open(workflow_path, 'r+') as file:
-                    print_message(f'Checking "{workflow_path}" for updates', message_type='group')
+                    print_message(
+                        f'Checking "{workflow_path}" for updates',
+                        message_type='group'
+                    )
 
                     file_data = file.read()
                     updated_config = file_data
@@ -93,14 +115,18 @@ def run(self):
                         if not latest_release:
                             continue
 
-                        updated_action = f'{action_repository}@{latest_release["tag_name"]}'
+                        updated_action = (
+                            f'{action_repository}@{latest_release["tag_name"]}'
+                        )
 
                         if action != updated_action:
                             print_message(
                                 f'Found new version for "{action_repository}"'
                             )
-                            comment += self.generate_comment_line(
-                                action_repository, latest_release
+                            pull_request_body.add(
+                                self.generate_pull_request_body_line(
+                                    action_repository, latest_release
+                                )
                             )
                             print_message(
                                 f'Updating "{action}" with "{updated_action}"'
@@ -123,25 +149,7 @@ def run(self):
                 print_message(f'Skipping "{workflow_path}"')
 
         if self.workflow_updated:
-            # Use timestamp to ensure uniqueness of the new branch
-            new_branch = f'gh-actions-update-{int(time.time())}'
-
-            print_message('Create New Branch', message_type='group')
-
-            subprocess.run(
-                ['git', 'checkout', self.base_branch]
-            )
-            subprocess.run(
-                ['git', 'checkout', '-b', new_branch]
-            )
-            subprocess.run(['git', 'add', '.'])
-            subprocess.run(
-                ['git', 'commit', '-m', 'Update GitHub Action Versions']
-            )
-
-            subprocess.run(['git', 'push', '-u', 'origin', new_branch])
-
-            print_message('', message_type='endgroup')
+            new_branch = self.create_new_branch()
 
             current_branch = subprocess.check_output(
                 ['git', 'rev-parse', '--abbrev-ref', 'HEAD']
@@ -150,9 +158,39 @@ def run(self):
             if new_branch in str(current_branch):
                 print_message('Create Pull Request', message_type='group')
 
-                self.create_pull_request(new_branch, comment)
+                pull_request_body_str = (
+                    '### GitHub Actions Version Updates\n' +
+                    ''.join(pull_request_body)
+                )
+                self.create_pull_request(new_branch, pull_request_body_str)
 
                 print_message('', message_type='endgroup')
+        else:
+            print_message('Everything is up-to-date! \U0001F389 \U0001F389')
+
+    def create_new_branch(self):
+        """Create and push a new branch with the changes"""
+        print_message('Create New Branch', message_type='group')
+
+        # Use timestamp to ensure uniqueness of the new branch
+        new_branch = f'gh-actions-update-{int(time.time())}'
+
+        subprocess.run(
+            ['git', 'checkout', self.base_branch]
+        )
+        subprocess.run(
+            ['git', 'checkout', '-b', new_branch]
+        )
+        subprocess.run(['git', 'add', '.'])
+        subprocess.run(
+            ['git', 'commit', '-m', 'Update GitHub Action Versions']
+        )
+
+        subprocess.run(['git', 'push', '-u', 'origin', new_branch])
+
+        print_message('', message_type='endgroup')
+
+        return new_branch
 
     def create_pull_request(self, branch_name, body):
         """Create pull request on GitHub"""
@@ -161,51 +199,37 @@ def create_pull_request(self, branch_name, body):
             'title': 'Update GitHub Action Versions',
             'head': branch_name,
             'base': self.base_branch,
-            'body': '### GitHub Actions Version Updates\n' + body,
+            'body': body,
         }
 
         response = requests.post(
-            url, json=payload, headers=self.get_request_headers()
+            url, json=payload, headers=self.get_request_headers
         )
 
         if response.status_code == 201:
             html_url = response.json()['html_url']
-            print_message(f'Pull request opened at {html_url}')
+            print_message(f'Pull request opened at {html_url} \U0001F389')
         else:
             msg = (
                 f'Could not create a pull request on '
                 f'{self.repository}, status code: {response.status_code}'
             )
             print_message(msg, message_type='warning')
 
-    def generate_comment_line(self, action_repository, latest_release):
-        """Generate Comment line for pull request body"""
+    def generate_pull_request_body_line(self, action_repository, latest_release):
+        """Generate pull request body line for pull request body"""
         return (
             f"* **[{action_repository}]({self.github_url + action_repository})** "
             "published a new release "
             f"[{latest_release['tag_name']}]({latest_release['html_url']}) "
             f"on {latest_release['published_at']}\n"
         )
 
-    def get_request_headers(self):
-        """Get headers for GitHub API request"""
-        headers = {
-            'Accept': 'application/vnd.github.v3+json'
-        }
-        # if the user adds `GITHUB_TOKEN` add it to API Request
-        # required for `private` repositories
-        if self.token:
-            headers.update({
-                'authorization': 'Bearer {token}'.format(token=self.token)
-            })
-
-        return headers
-
     def get_latest_release(self, action_repository):
         """Get latest release using GitHub API """
         url = f'{self.github_api_url}/repos/{action_repository}/releases/latest'
 
-        response = requests.get(url, headers=self.get_request_headers())
+        response = requests.get(url, headers=self.get_request_headers)
         data = {}
 
         if response.status_code == 200:
@@ -231,7 +255,7 @@ def get_workflow_paths(self):
         """Get all workflows of the repository using GitHub API """
         url = f'{self.github_api_url}/repos/{self.repository}/actions/workflows'
 
-        response = requests.get(url, headers=self.get_request_headers())
+        response = requests.get(url, headers=self.get_request_headers)
         data = []
 
         if response.status_code == 200: