Merge pull request #688 from geofffranks/contributions-for-user

Add script to help reviewers gather info for becoming approvers

toc/ROLES.md

@@ -300,6 +300,12 @@ approver in an OWNERS file:
    - A technical discussion is a thread on slack or in GitHub that requires knowledge of the codebase. The following are examples of technical discussions that will be considered: resolving interrupts in slack, or commenting on proposals. Technical discussions are counted per-thread, not per-message.
    - The WG lead has final say if an issue, PR, or discussion is considered substantial.
 
+The [contributions-for-user.sh script](https://github.com/cloudfoundry/community/blob/main/toc/working-groups/contributions-for-user.sh) can be used to help gather information from GitHub related to Issues, PRs, and code contributions. It requires the `gh` CLI, and for users to authenticate with credentials allowing Gist creation:
+
+```
+./working-groups/contributions-for-user.sh <github username> <working group name>
+```
+
 - Nominated by a WG lead (with no objections from other leads).
 
 ### Responsibilities and privileges

toc/working-groups/contributions-for-user.sh

@@ -0,0 +1,123 @@
+#!/bin/bash
+
+set -e -o pipefail
+
+repo_root=$(dirname "$(cd "$( dirname "${BASH_SOURCE[0]}" )/.." && pwd)")
+
+pushd "${repo_root}/toc/working-groups" >/dev/null
+
+USERNAME=$1
+shift || true
+WORKING_GROUP="$*"
+
+echo "Parsing working group metadata..."
+TOC_JSON=$(${repo_root}/toc/working-groups/parsable-working-groups.sh)
+
+declare -a WORKING_GROUPS
+IFS=$'\n'
+WORKING_GROUPS=($(echo "${TOC_JSON}" | jq -r '.[].name'))
+
+list_working_groups() {
+  for wg in "${WORKING_GROUPS[@]}"; do
+    echo "- ${wg}"
+  done
+}
+
+usage_checks() {
+  if [[ ! -e $(which gh) ]]; then
+    echo 'The `gh` cli is required for this script' >&2
+    exit 1
+  fi
+
+  if gist_url=$(echo "test" | gh gist create -d test -f test - 2>/dev/null); then
+    gh gist delete "${gist_url}" >/dev/null 2>&1
+  else 
+    echo 'Please login to GitHub with the `gh` cli using credentials with permissions to create gists' >&2
+    exit 1
+  fi
+
+  if [[ -z "${USERNAME}" ]]; then
+    echo "Usage: contributions-for-user.sh <github-username> <working group name>" >&2
+    echo "Where working group name is one of:" >&2
+    list_working_groups >&2
+    exit 1
+  fi
+
+  for wg in "${WORKING_GROUPS[@]}"; do
+    if [[ "${wg}" == "${WORKING_GROUP}" ]]; then
+      match=1
+      break
+    fi
+  done
+  if [[ "${match}" != 1 ]]; then
+    echo "Working group name must be one of:" >&2
+    list_working_groups >&2
+    exit 1
+  fi
+}
+
+find_commits_for_repo() {
+  local user=$1
+  local repo=$2
+
+  if commits=$(gh api --paginate "repos/${repo}/commits?author=${user}&per_page=100" 2>/dev/null); then
+    echo "${commits}" |  jq -r '.[] | "- " + .commit.author.date + ": [" + (.commit.message | split("\n"))[0] + "](" + .html_url + ")"'
+  fi
+  if commits=$(gh api --paginate "repos/${repo}/commits?committer=${user}&per_page=100" 2>/dev/null); then
+    echo "${commits}" |  jq -r '.[] | "- " + .commit.committer.date + ": [" + (.commit.message | split("\n"))[0] + "](" + .html_url + ")"'
+  fi
+}
+
+find_prs_for_repo() {
+  local user=$1
+  local repo=$2
+
+  echo "${EVENTS_JSON}" | jq -r --arg repo "${repo}" '.[] | select([.type] | inside(["PullRequestReviewEvent"])) | select(.repo.name == $repo) | "- " + .payload.pull_request.created_at + ": [" +.payload.pull_request.title + "](" + .payload.pull_request.html_url + ")"'
+  echo "${EVENTS_JSON}" | jq -r --arg user "${user}" --arg repo "${repo}" '.[] | select([.type] | inside(["PullRequestReviewCommentEvent"])) | select(.repo.name == $repo) | select(.payload.pull_request.user.login != $user) | "- " + .payload.pull_request.created_at + ": [" +.payload.pull_request.title + "](" + .payload.pull_request.html_url + ")"'
+
+}
+
+find_issues_for_repo() {
+  local user=$1
+  local repo=$2
+
+  if issues=$(gh api --paginate "repos/${repo}/issues?creator=${user}&state=all" 2>/dev/null); then
+    echo "${issues}" | jq -r '.[] | "- " + .created_at + ": [" + .title + "](" + .html_url + ")"'
+  fi
+  if issues=$(gh api --paginate "repos/${repo}/issues?mentioned=${user}&state=all" 2>/dev/null); then
+    echo "${issues}" | jq -r '.[] | "- " + .created_at + ": [" + .title + "](" + .html_url + ")"'
+  fi
+  echo "${EVENTS_JSON}" | jq -r --arg user "${user}" --arg repo "${repo}" '.[] | select([.type] | inside(["IssueCommentEvent"])) | select(.repo.name == $repo) | select(.payload.issue.user.login != $user) | "- " + .payload.issue.created_at + ": [" +.payload.issue.title + "](" + .payload.issue.html_url + ")"'
+}
+
+  usage_checks
+  set -u
+
+  echo "Gathering GH events..."
+  EVENTS_JSON=$(gh api --paginate "users/${USERNAME}/events?per_page=100")
+
+  declare -a areas
+  areas=($(echo "${TOC_JSON}" | jq --arg wg_name "${WORKING_GROUP}" -r '.[] | select(.name == $wg_name) | .areas[].name'))
+  for area in "${areas[@]}"; do
+    echo "Gathering contributions for the '${WORKING_GROUP}: ${area}' area..."
+    uri_safe_file=$(echo "${wg} - ${area}.md" | jq  -sRr '@uri')
+    gist_url=$( (
+    echo "# ${WORKING_GROUP}: ${area} Contributions"
+    declare -a repos
+    repos=($(echo "${TOC_JSON}" | jq -r --arg wg_name "${WORKING_GROUP}" --arg area "${area}" '.[] | select(.name == $wg_name) | .areas[] | select(.name == $area) | .repositories[]'))
+    echo "### PRs Commented on/Reviewed:"
+    for repo in "${repos[@]}"; do
+      find_prs_for_repo "${USERNAME}" "${repo}"
+    done | sort -u
+    echo "### Issues that may be relevant:"
+    for repo in "${repos[@]}"; do
+      find_issues_for_repo  "${USERNAME}" "${repo}"
+    done | sort -u
+    echo "### Code contributions:"
+    for repo in "${repos[@]}"; do
+        find_commits_for_repo "${USERNAME}" "${repo}" 
+    done | sort -u
+    echo
+    ) | gh gist create -d "${USERNAME}'s Possible Contributions to ${WORKING_GROUP} - ${area}" -f "${uri_safe_file}" - 2>/dev/null)
+    echo "Contributions have been summarized at ${gist_url}"
+  done