github: Automatically create backport requests for bugs referenced in commit messages

[tstellar]

Summary

This adds a new action that will automatically create a backport request
for the release branch any time a bug is automatically closed by
having a reference to it (e.g. Fixes #12345) in a commit message.

[kwk]

.github/workflows/issue-release-workflow.yml

18

I forgot to mention this but it's tricky with issue comments. An issue comment can also be a PR comment and you don't want your workflow to run then I bet. That's why you need to exclude PR comments. I know we don't have PRs yet but who knows. Here you can read on how to exclude PR comments from the game: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issue_comment-on-issues-only-or-pull-requests-only .

61

While this may be okay for now I suggest to make this selection explicit instead of indirectly implicit. The next time you add or remove an event type in the on section above (e.g. add labeled as an event type), the logic here breaks. I suggest to have this formulated out. Here's a list of all possible activity types: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issues . You certainly limit the scope in the on section already but the moment you widen this, you have to check this place again. And that should be avoided IMHO.

96

Same here, please make this explicit.

llvm/utils/git/github-automation.py

21

I suggest to use a query with placeholders and change this to:

def run_graphql_query(query: str, variables: dict, token: str) -> dict:

Also, please add a documentation since this will soon become a commonly called function I guess.

22–24

Maybe this is better depending on if you plan to use node IDs:

headers = {
    'Authorization' : 'bearer {}'.format(token),
    # See
    # https://github.blog/2021-11-16-graphql-global-id-migration-update/
    'X-Github-Next-Global-ID': '1'
}

27

Change to

json = {"query": query, "variables": variables}

434–465

I suggest to pass in a clean query so you can always copy'n'paste the query from here to execute it for testing purposes on the graphql explorer. The variables help with this. Here's a patch:

diff --git a/llvm/utils/git/github-automation.py b/llvm/utils/git/github-automation.py
index 62c9886b52f0..b0fa1b3c126b 100755
--- a/llvm/utils/git/github-automation.py
+++ b/llvm/utils/git/github-automation.py
@@ -17,13 +17,16 @@ import requests
 import sys
 from typing import *
 
-def run_graphql_query(query: str, token: str) -> dict:
+def run_graphql_query(query: str, token: str, variables: dict) -> dict:
     headers = {
         'Authorization' : 'bearer {}'.format(token),
+        # See
+        # https://github.blog/2021-11-16-graphql-global-id-migration-update/
+        'X-Github-Next-Global-ID': '1'
     }
     request = requests.post(
         url = 'https://api.github.com/graphql',
-        json = {"query" : query },
+        json = {"query" : query , "variables": variables},
         headers = headers)
 
     if request.status_code == 200:
@@ -275,9 +278,9 @@ def create_cherry_pick_request_from_closed_issue(issue:int, repo_name:str, token
     [owner, name] = repo_name.split('/')
 
     query = """
-        query {
-            repository(owner: """ f'"{owner}"'', name: 'f'"{name}"'""") {
-                issue(number: """f'{issue}'""") {
+        query($owner: String!, $name: String!, $issue_number: Int!){
+            repository(owner: $owner, name: $name) {
+                issue(number: $issue_number) {
                     title
                     timelineItems (itemTypes: [CLOSED_EVENT], last: 1) {
                         edges {
@@ -306,8 +309,13 @@ def create_cherry_pick_request_from_closed_issue(issue:int, repo_name:str, token
                 }
             }
         }"""
+    variables = {
+        "owner": owner,
+        "name": name,
+        "issue_number": issue,
+    }
 
-    data = run_graphql_query(query, token)
+    data = run_graphql_query(query, variables, token)
     title = data['repository']['issue']['title']
     event = data['repository']['issue']['timelineItems']['edges']
     authors = []
@@ -328,7 +336,8 @@ def create_cherry_pick_request_from_closed_issue(issue:int, repo_name:str, token
             milestone = m
             break
 
-    message = '{} What do you think about backporting {}?\n\n/cherry-pick {}'.format(' '.join(['@' + login for login in assignees]), 'this' if len(commits) == 1 else 'these', ' '.join(commits))
+    annotated_assignees = ' '.join(['@' + login for login in assignees])
+    message = '{} What do you think about backporting {}?\n\n/cherry-pick {}'.format(annotated_assignees, 'this commit' if len(commits) == 1 else 'these commits', ' '.join(commits))
     gh_issue = repo.create_issue(title='Cherry-pick fixes for #{}: {}'.format(issue, title),
                                  assignees=assignees,
                                  milestone=milestone,

439

This is cool. It looks like you've taken into account that an issue could be closed and reopened. But I wonder if it is enough to just focus on the last close event. What if you close an issue with a commit but missed out and edge case and later create a fixup commit. This will not be covered here but afterall we're humans and need to judge. This is just a nudge in the right direction I guess.

488

Change:

this to this commit and
these to these commits.

You also might want to make the commits a set just in case they occur more than once.

489–492

You might want to label this issue in some way.

500

commits -> commit(s)

[tstellar]

Rebase and simplify.

[tstellar]

.github/workflows/issue-release-workflow.yml

61

Would it be better just to move this new job to another file? That would avoid having all the complicated logic to filter out the different event types.

[tstellar]

Address review comments.

[tstellar]

llvm/utils/git/github-automation.py

439

I'm just trying to get the closed event that triggered the workflow run. If there is another closed event later, it should trigger a new workflow and that workflow will be able to pick up any commits.

[kwk]

.github/workflows/issue-release-workflow.yml

40

Just as a hint: I noticed in one of your other PRs that they have released v3 and you're using it there.

llvm/utils/git/github-automation.py

33–42

I wonder if this shouldn't be renamed from request to response.

429

488

[kwk]

.github/workflows/issue-release-workflow.yml

34–36

@tstellar the issue_comment trigger will also trigger on review comments for a PR and want to exclude that, don't you?

.github/workflows/issue-release-workflow.yml

 # /branch <owner>/<repo>/<branch>
 #
 # This comment will create a pull request from <branch> to the latest release
 # branch.
 
 name: Issue Release Workflow
 
 on:
   issue_comment:
     types:
       - created
       - edited
   issues:
     types:
       - opened
+      - closed
 
 env:
   COMMENT_BODY: ${{ github.event.action == 'opened' && github.event.issue.body || github.event.comment.body  }}
 
 jobs:
+  request-backport:
+    name: Request Backport
+    runs-on: ubuntu-20.04
+    if: >-
+        (github.repository == 'llvm/llvm-project') &&
+        github.event.action == 'closed'
+
+    steps:
+      - name: Fetch LLVM sources
+        uses: actions/checkout@v2
+        with:
+          persist-credentials: false
+
+      - name: Setup Environment
+        run: |
+          pip install -r ./llvm/utils/git/requirements.txt
+
+      - name: Create Backport
+        run: |
+          ./llvm/utils/git/github-automation.py \
+          --repo $GITHUB_REPOSITORY \
+          --token ${{ secrets.RELEASE_WORKFLOW_PUSH_SECRET }} \
+          release-workflow \
+          --issue-number ${{ github.event.issue.number }} \
+          request-cherry-pick
+
   backport-commits:
     name: Backport Commits
     runs-on: ubuntu-20.04
     if: >-
       (github.repository == 'llvm/llvm-project') &&
+      github.event.action != 'closed' &&
       !startswith(github.event.comment.body, '<!--IGNORE-->') &&
       contains(github.event.action == 'opened' && github.event.issue.body || github.event.comment.body, '/cherry-pick')
     steps:
       - name: Fetch LLVM sources
         uses: actions/checkout@v2
         with:
           repository: llvm/llvm-project
           # GitHub stores the token used for checkout and uses it for pushes
steps:
           --issue-number ${{ github.event.issue.number }} \
           --phab-token ${{ secrets.RELEASE_WORKFLOW_PHAB_TOKEN }} \
           auto
 
   create-pull-request:
     name: Create Pull Request
     runs-on: ubuntu-20.04
     if: >-
       (github.repository == 'llvm/llvm-project') &&
+      github.event.action != 'closed' &&
       !startswith(github.event.comment.body, '<!--IGNORE-->') &&
       contains(github.event.comment.body, '/branch')
 
     steps:
       - name: Fetch LLVM sources
         uses: actions/checkout@v2
         with:
           persist-credentials: false

llvm/utils/git/github-automation.py

 import github
 import os
 import re
 import requests
 import sys
 import time
 from typing import *
 
+def run_graphql_query(query: str, variables: dict, token: str) -> dict:
+    """
+    This function submits a graphql query and returns the results as a
+    dictionary.
+    """
+
+    headers = {
+        'Authorization' : 'bearer {}'.format(token),
+        # See
+        # https://github.blog/2021-11-16-graphql-global-id-migration-update/
+        'X-Github-Next-Global-ID': '1'
+    }
+    request = requests.post(
+        url = 'https://api.github.com/graphql',
+        json = {"query" : query, "variables" : variables },
+        headers = headers)
+
+    if request.status_code == 200:
+        return request.json()['data']
+    else:
+        raise Exception(
+            "Failed to run graphql query\nquery: {}\nerror: {}".format(query, request.json()))
+
 class IssueSubscriber:
 
     @property
     def team_name(self) -> str:
         return self._team_name
 
     def __init__(self, token:str, repo:str, issue_number:int, label_name:str):
         self.repo = github.Github(token).get_repo(repo)
def execute_command(self) -> bool:
                     repo = m.group(2)
                     branch = m.group(3)
                     return self.create_pull_request(owner, repo, branch)
 
         print("Do not understand input:")
         print(sys.stdin.readlines())
         return False
 
+
+    def request_cherry_pick(self) -> bool:
+        """
+        Request a cherry-pick of the commits that fixed `issue` by creating a new
+        issue and attaching it to the release milestone.
+        """
+
+        query = """
+            query ($owner: String!, $name: String!, $issue_number: Int!){
+                repository(owner: $owner, name: $name) {
+                    issue(number: $issue_number) {
+                        timelineItems (itemTypes: [CLOSED_EVENT], last: 1) {
+                            edges {
+                                node {
+                                    __typename
+                                    ... on ClosedEvent {
+                                        closer {
+                                            ... on Commit {
+                                                oid
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }"""
+
+        variables = {
+            "owner" : self.repo.owner.login,
+            "name" : self.repo.name,
+            "issue_number" : self.issue_number
+        }
+
+        data = run_graphql_query(query, variables, self.token)
+        event = data['repository']['issue']['timelineItems']['edges']
+        commits = []
+        for e in event:
+            commits.append(e['node']['closer']['oid'])
+        # Find the most recent release milestone
+        milestone = None
+        for m in self.repo.get_milestones(state='open'):
+            if re.search('branch: release', m.description):
+                milestone = m
+                break
+
+        self.issue.edit(milestone = milestone)
+        self.issue.create_comment("/cherry-pick {}".format(" ".join(commits)))
+
+
 parser = argparse.ArgumentParser()
 parser.add_argument('--token', type=str, required=True, help='GitHub authentiation token')
 parser.add_argument('--repo', type=str, default=os.getenv('GITHUB_REPOSITORY', 'llvm/llvm-project'),
                     help='The GitHub repository that we are working with in the form of <owner>/<repo> (e.g. llvm/llvm-project)')
 subparsers = parser.add_subparsers(dest='command')
 
 issue_subscriber_parser = subparsers.add_parser('issue-subscriber')
 issue_subscriber_parser.add_argument('--label-name', type=str, required=True)
 issue_subscriber_parser.add_argument('--issue-number', type=int, required=True)
 
 release_workflow_parser = subparsers.add_parser('release-workflow')
 release_workflow_parser.add_argument('--llvm-project-dir', type=str, default='.', help='directory containing the llvm-project checout')
 release_workflow_parser.add_argument('--issue-number', type=int, required=True, help='The issue number to update')
 release_workflow_parser.add_argument('--phab-token', type=str, help='Phabricator conduit API token. See https://reviews.llvm.org/settings/user/<USER>/page/apitokens/')
 release_workflow_parser.add_argument('--branch-repo-token', type=str,
                                      help='GitHub authentication token to use for the repository where new branches will be pushed. Defaults to TOKEN.')
 release_workflow_parser.add_argument('--branch-repo', type=str, default='llvm/llvm-project-release-prs',
                                      help='The name of the repo where new branches will be pushed (e.g. llvm/llvm-project)')
-release_workflow_parser.add_argument('sub_command', type=str, choices=['print-release-branch', 'auto'],
+release_workflow_parser.add_argument('sub_command', type=str, choices=['print-release-branch', 'auto', 'request-cherry-pick'],
                                      help='Print to stdout the name of the release branch ISSUE_NUMBER should be backported to')
 
 llvmbot_git_config_parser = subparsers.add_parser('setup-llvmbot-git', help='Set the default user and email for the git repo in LLVM_PROJECT_DIR to llvmbot')
 
 args = parser.parse_args()
 
 if args.command == 'issue-subscriber':
     issue_subscriber = IssueSubscriber(args.token, args.repo, args.issue_number, args.label_name)
     issue_subscriber.run()
 elif args.command == 'release-workflow':
     release_workflow = ReleaseWorkflow(args.token, args.repo, args.issue_number,
                                        args.branch_repo, args.branch_repo_token,
                                        args.llvm_project_dir, args.phab_token)
+    if args.sub_command == 'request-cherry-pick':
+        release_workflow.request_cherry_pick()
+        sys.exit(0)
     if not release_workflow.release_branch_for_issue:
         release_workflow.issue_notify_no_milestone(sys.stdin.readlines())
         sys.exit(1)
     if args.sub_command == 'print-release-branch':
         release_workflow.print_release_branch()
     else:
         if not release_workflow.execute_command():
             sys.exit(1)
 elif args.command == 'setup-llvmbot-git':
     setup_llvmbot_git()