Update workflow (#2)

Adding clean commit message from automerger, includes link to PR and PR name. 
Cleaning up workflow tests, now utilizing automerger-test to run against a repository testing valid PR states.

Author: F-WRunTime

.github/workflows/basic-validation.yaml

@@ -1,6 +1,10 @@
 name: Test Workflow
 
-on: [workflow_dispatch]
+on: 
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - master
 
 jobs:
   list:
@@ -33,3 +37,4 @@ jobs:
           org: 'runtimeverification'
           repo: ${{ matrix.value }}
           token: ${{ secrets.JENKINS_GITHUB_PAT }}
+          debug: --dry-run

.github/workflows/test.yaml

@@ -23,6 +23,7 @@ Any PR with the following criteria will be updated and test will be run before m
   - [Example workflow using Automerge across a Github Organization](#example-workflow-using-automerge-across-a-github-organization)
   - [The Workflow](#the-workflow)
   - [Reduce CI Pressure](#reduce-ci-pressure)
+  - [Run Locally](#run-locally)
 
 # Example workflow using Automerge across a Github Organization
 This example workflow will run every 20 minutes and will automerge PRs for tracked repositories in the organization.
@@ -104,3 +105,19 @@ on:
 ...
 ...
 ```
+
+# Run Locally
+Checkout the repository you wish to run automerge on to a local directory. 
+```bash
+git clone [email protected]:org/automerge.git
+cd automerge
+```
+
+Now you need to run the command from this new directory 
+```bash
+$(pwd)/../src/automerge.py --org runtimeverification --repo automerger-test --dry-run
+```
+
+Recommended to first review the actions before running without. Then remove the `--dry-run` flag to run the action. 
+
+

README.md

@@ -14,6 +14,10 @@ inputs:
   token:
     description: 'Access token to be able to write to the repository'
     required: true
+  debug:
+    description: 'Debug mode'
+    required: false
+    default: ''
 outputs: 
   merged:
     value: ${{ steps.automerge.outputs.merged }}
@@ -49,5 +53,5 @@ runs:
       env:
         GITHUB_TOKEN: ${{ inputs.token }}
       working-directory: tmp-${{ inputs.repo }}
-      run: python3 ${{ github.action_path }}/src/automerge.py --org ${{ inputs.org }} --repo ${{ inputs.repo }}
+      run: python3 ${{ github.action_path }}/src/automerge.py --org ${{ inputs.org }} --repo ${{ inputs.repo }} ${{ inputs.debug }}
 

action.yaml

@@ -13,7 +13,7 @@
 parser = argparse.ArgumentParser(description='Automerge approved PRs.')
 parser.add_argument('--repo', type=str, help='The repository to check.')
 parser.add_argument('--org', type=str, help='The GitHub organization to check.')
-parser.add_argument('--dry-run', action='store_true', help='Enable DR run mode.')
+parser.add_argument('--dry-run', action='store_true', default=False, help='Enable Debug/Dry-Run mode.')
 args = parser.parse_args()
 
 _LOGGER: Final = logging.getLogger(__name__)
@@ -98,13 +98,13 @@ def run_git_command(command_args: str) -> subprocess.CompletedProcess:
 # - Approved, and
 # - Up-to-date.
 # If so, merge
-if automerge_up_to_date_prs:
+while automerge_up_to_date_prs:
     pr = automerge_up_to_date_prs[0]
     _LOGGER.info(f' Merging PR:\n{pr_to_display_string(pr)}\n')
     if args.dry_run:
         _LOGGER.info(f'Would have merged PR:\n{pr_to_display_string(pr)}\n')
     else:
-        pr.merge(merge_method='squash')
+        pr.merge(merge_method='squash', commit_message=f'Automerge {pr.html_url}: {pr.title}')
     automerge_up_to_date_prs.pop(0)
 
 # 5. Get PRs that are:

src/automerge.py

@@ -1,3 +1,3 @@
 [
-  "devops-actions"
+  "automerger-test"
 ]