Merge pull request #12 from thehedgefrog/main

Allow custom commit message and pull request title

Author: saadmk11

README.md

@@ -7,7 +7,7 @@
 ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/saadmk11/github-actions-version-updater/Changelog%20CI?label=Changelog%20CI&style=flat-square)
 
 **GitHub Actions Version Updater** is GitHub Action that is used to **update other GitHub Actions** in a Repository
-and create a **pull request** with the updates. It is an automated dependency updater similar to GitHub's **Dependabot**, 
+and create a **pull request** with the updates. It is an automated dependency updater similar to GitHub's **Dependabot**,
 but for GitHub Actions.
 
 ### How Does It Work:
@@ -24,16 +24,16 @@ but for GitHub Actions.
 
 ### Usage:
 
-We recommend running this action on a [`schedule`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#schedule) 
+We recommend running this action on a [`schedule`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#schedule)
 event or a [`workflow_dispatch`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_dispatch) event.
 
-To integrate `GitHub Actions Version Updater` on your repository, create a `YAML`  file 
+To integrate `GitHub Actions Version Updater` on your repository, create a `YAML`  file
 inside `.github/workflows/` directory (`.github/workflows/updater.yaml`) add the following into the file:
 
 ```yaml
 name: GitHub Actions Version Updater
 
-# Controls when the action will run. 
+# Controls when the action will run.
 on:
   # can be used to run workflow manually
   workflow_dispatch:
@@ -44,7 +44,7 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
-  
+
     steps:
       - uses: actions/checkout@v2
         with:
@@ -58,6 +58,10 @@ jobs:
           # defaults to `github-actions[bot]` if not provided
           committer_username: 'test'
           committer_email: 'test@test.com'
+          # Optional, allows customizing the commit message and pull request title
+          # Both default to 'Update GitHub Action Versions'
+          commit_message: 'Commit Message'
+          pull_request_title: 'Pull Request Title'
           # Access token with `workflow` scope is required
           token: ${{ secrets.WORKFLOW_SECRET }}
           # Do not update these actions (Optional)

action.yaml

@@ -13,6 +13,14 @@ inputs:
     description: 'Email Address of that user who will commit'
     required: false
     default: 'github-actions[bot]@users.noreply.github.com'
+  commit_message:
+    description: 'Commit message for the commits by the action'
+    required: false
+    default: 'Update GitHub Action Versions'
+  pull_request_title:
+    description: 'Title for the pull requests generated by the action'
+    required: false
+    default: 'Update GitHub Action Versions'
   ignore:
     description: 'A JSON array which denotes the actions that should not be updated'
     required: false

main.py

@@ -15,10 +15,12 @@ class GitHubActionsVersionUpdater:
     github_url = 'https://github.com/'
     action_label = 'uses'
 
-    def __init__(self, repository, base_branch, token, ignore_actions=None):
+    def __init__(self, repository, base_branch, token, commit_message=None, pr_title=None, ignore_actions=None):
         self.repository = repository
         self.base_branch = base_branch
         self.token = token
+        self.commit_message = commit_message or 'Update GitHub Action Versions'
+        self.pr_title = pr_title or 'Update GitHub Action Versions'
         self.ignore_actions = self.get_ignored_actions(ignore_actions)
         self.workflow_updated = False
 
@@ -183,7 +185,7 @@ def create_new_branch(self):
         )
         subprocess.run(['git', 'add', '.'])
         subprocess.run(
-            ['git', 'commit', '-m', 'Update GitHub Action Versions']
+            ['git', 'commit', '-m', self.commit_message]
         )
 
         subprocess.run(['git', 'push', '-u', 'origin', new_branch])
@@ -196,7 +198,7 @@ def create_pull_request(self, branch_name, body):
         """Create pull request on GitHub"""
         url = f'{self.github_api_url}/repos/{self.repository}/pulls'
         payload = {
-            'title': 'Update GitHub Action Versions',
+            'title': self.pr_title,
             'head': branch_name,
             'base': self.base_branch,
             'body': body,
@@ -312,6 +314,10 @@ def print_message(message, message_type=None):
     email = os.environ['INPUT_COMMITTER_EMAIL']
     # Actions that should not be updated
     ignore = os.environ['INPUT_IGNORE']
+    # Commit message
+    commit_message = os.environ['INPUT_COMMIT_MESSAGE']
+    # Pull Request Title
+    pr_title = os.environ['INPUT_PULL_REQUEST_TITLE']
 
     # Group: Configure Git
     print_message('Configure Git', message_type='group')
@@ -326,7 +332,7 @@ def print_message(message, message_type=None):
 
     # Initialize GitHubActionsVersionUpdater
     actions_version_updater = GitHubActionsVersionUpdater(
-        repository, base_branch, token, ignore_actions=ignore
+        repository, base_branch, token, commit_message=commit_message, pr_title=pr_title, ignore_actions=ignore
     )
     actions_version_updater.run()