Self-Service Fork Request: PR Workflow

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,13 +1,26 @@
-# 🔄 OSPO Automation PR Menu
+# 🔁 Fork a repository
 
-🚨 INSTRUCTIONS: Click the `Preview` tab above, then select your desired PR template below!
+🚨 INSTRUCTIONS: Click the `Preview` tab above, then follow along below!
 
-## Self-Service Requests
+## Description
 
-- ✅ [Fork a repository](?expand=1&template=fork-repo.md)
-- ❌ [Create a new repository](?expand=1&template=create-repo.md)
-- ❌ [Migrate an existing repository](?expand=1&template=migrate-repo.md)
+This PR template is intended for Wayfair developers requesting [repository forks](https://docs.github.com/en/get-started/quickstart/fork-a-repo) into the [`/wayfair-contribs`](https://github.com/wayfair-contribs) organization, to enable upstream contributions to existing open source projects.
 
-## Developer Contributions
+**You must already be a GitHub organization member of `/wayfair-contribs`** (and preferrably, [`/wayfair`](https://github.com/wayfair) + [`/wayfair-incubator`](https://github.com/wayfair-incubator) as well) **in order to use this workflow**. The repository you are requesting a fork of must also comply with our current list of approved open source licenses: **MIT**, **BSD** (3-clause, 2-clause, 0-clause), **Apache** (1.0, 1.1, 2.0).
 
-- ✅ [Contribute to the codebase](?expand=1&template=standard-pr.md)
+> 🚨  If you aren't already a member of Wayfair's open source GitHub organizations, please refer to internal Wayfair OSPO documentation on adding yourself to the `ospo-names` repository, or reach out on our internal Slack channel (`#open-source-forum`) if you need further assistance!
+
+## Instructions
+
+> **💡 Please follow all instructions in the [Fork a repository README](https://github.com/wayfair/ospo-automation/blob/main/requests/fork/README.md) before filing your Pull Request using this template!**
+
+## Checklist
+
+- [ ] I have confirmed that I am already a member of the `/wayfair-contribs` GitHub organization
+- [ ] I have confirmed that the repository I wish to fork is compliant with our [approved list of licenses](#description)
+- [ ] I have reviewed the [Fork a repository README](https://github.com/wayfair/ospo-automation/blob/main/requests/fork/README.md) and created a compliant `.yml` request file
+- [ ] I have created a git branch name which follows the documented pattern of `fork-repo-<REPO-NAME>`
+
+> 💡 During the beta rollout of this fully self-service workflow, you may encounter some errors or edge cases we have not accounted for yet. For any issues or feedback on using this workflow, please reach out to [Wayfair OSPO](https://wayfair.github.io) internally on Slack (`#open-source-forum`) and we can lend a hand!
+
+🚨 Not the PR template you wanted? Click the `Preview` tab above, then navigate to the [OSPO Automation PR Menu](?expand=1&template=pr-menu.md)!

.github/PULL_REQUEST_TEMPLATE/create-repo.md

@@ -2,4 +2,4 @@
 
 ## COMING SOON
 
-🚨 Not the PR template you wanted? Click the `Preview` tab above, then navigate back to the [OSPO Automation PR Menu](?expand=1)!
+🚨 Not the PR template you wanted? Click the `Preview` tab above, then navigate to the [OSPO Automation PR Menu](?expand=1&template=pr-menu.md)!

.github/PULL_REQUEST_TEMPLATE/fork-repo.md

@@ -4,7 +4,9 @@
 
 ## Description
 
-This PR template is intended for requesting [repository forks](https://docs.github.com/en/get-started/quickstart/fork-a-repo) into the [`/wayfair-contribs`](https://github.com/wayfair-contribs) organization, to enable upstream contributions to existing open source projects. **You must already be a GitHub organization member of `/wayfair-contribs`** (and preferrably, [`/wayfair`](https://github.com/wayfair) + [`/wayfair-incubator`](https://github.com/wayfair-incubator) as well) **in order to use this workflow**. The repository you are requesting a fork of must also comply with our current list of approved open source licenses: **MIT**, **BSD** (3-clause, 2-clause, 0-clause), **Apache** (1.0, 1.1, 2.0).
+This PR template is intended for Wayfair developers requesting [repository forks](https://docs.github.com/en/get-started/quickstart/fork-a-repo) into the [`/wayfair-contribs`](https://github.com/wayfair-contribs) organization, to enable upstream contributions to existing open source projects.
+
+**You must already be a GitHub organization member of `/wayfair-contribs`** (and preferrably, [`/wayfair`](https://github.com/wayfair) + [`/wayfair-incubator`](https://github.com/wayfair-incubator) as well) **in order to use this workflow**. The repository you are requesting a fork of must also comply with our current list of approved open source licenses: **MIT**, **BSD** (3-clause, 2-clause, 0-clause), **Apache** (1.0, 1.1, 2.0).
 
 > 🚨  If you aren't already a member of Wayfair's open source GitHub organizations, please refer to internal Wayfair OSPO documentation on adding yourself to the `ospo-names` repository, or reach out on our internal Slack channel (`#open-source-forum`) if you need further assistance!
 
@@ -19,6 +21,6 @@ This PR template is intended for requesting [repository forks](https://docs.gith
 - [ ] I have reviewed the [Fork a repository README](https://github.com/wayfair/ospo-automation/blob/main/requests/fork/README.md) and created a compliant `.yml` request file
 - [ ] I have created a git branch name which follows the documented pattern of `fork-repo-<REPO-NAME>`
 
-> 💡 In the initial rollout of this workflow, requests filed as PRs will be semi-automated, with some manual verification and processing still performed by the OSPO team upon receipt. However, in the future, this workflow will become fully self-serviceable through automated PR checks and GitHub Actions-driven workflows! 🎉
+> 💡 During the beta rollout of this fully self-service workflow, you may encounter some errors or edge cases we have not accounted for yet. For any issues or feedback on using this workflow, please reach out to [Wayfair OSPO](https://wayfair.github.io) internally on Slack (`#open-source-forum`) and we can lend a hand!
 
-🚨 Not the PR template you wanted? Click the `Preview` tab above, then navigate back to the [OSPO Automation PR Menu](?expand=1)!
+🚨 Not the PR template you wanted? Click the `Preview` tab above, then navigate to the [OSPO Automation PR Menu](?expand=1&template=pr-menu.md)!

.github/PULL_REQUEST_TEMPLATE/migrate-repo.md

@@ -2,4 +2,4 @@
 
 ## COMING SOON
 
-🚨 Not the PR template you wanted? Click the `Preview` tab above, then navigate back to the [OSPO Automation PR Menu](?expand=1)!
+🚨 Not the PR template you wanted? Click the `Preview` tab above, then navigate to the [OSPO Automation PR Menu](?expand=1&template=pr-menu.md)!

.github/PULL_REQUEST_TEMPLATE/pr-menu.md

@@ -0,0 +1,13 @@
+# 🔄 OSPO Automation PR Menu
+
+🚨 INSTRUCTIONS: Click the `Preview` tab above, then select your desired PR template below!
+
+## Self-Service Requests
+
+- ✅ [Fork a repository](?expand=1)
+- ❌ [Create a new repository](?expand=1&template=create-repo.md) [COMING SOON]
+- ❌ [Migrate an existing repository](?expand=1&template=migrate-repo.md) [COMING SOON]
+
+## Developer Contributions
+
+- ✅ [Contribute to the codebase](?expand=1&template=standard-pr.md)

.github/PULL_REQUEST_TEMPLATE/standard-pr.md

@@ -23,4 +23,4 @@ Note that by _not_ including a description, you are asking reviewers to do extra
 - [ ] New code contribution is covered by automated tests
 - [ ] All new and existing tests pass
 
-🚨 Not the PR template you wanted? Click the `Preview` tab above, then navigate back to the [OSPO Automation PR Menu](?expand=1)!
+🚨 Not the PR template you wanted? Click the `Preview` tab above, then navigate to the [OSPO Automation PR Menu](?expand=1&template=pr-menu.md)!

.github/workflows/fork.yml

@@ -1,46 +1,83 @@
 name: fork
 
-on: # Only trigger on manual input
-  workflow_dispatch:
-    inputs:
-      owner:
-        description: 'Owner of GitHub repo to be forked'
-        required: true
-      repo:
-        description: 'GitHub repo to be forked'
-        required: true
-      org:
-        description: 'GitHub org to fork the repo into'
-        required: true
-        default: wayfair-contribs
-      user:
-        description: 'GitHub user requesting the fork'
-        required: true
-      checkUser:
-        description: 'Enforce organization membership for GitHub user?'
-        required: true
-        default: true
-      promoteUser:
-        description: 'Promote GitHub user to admin of the forked repo?'
-        required: true
-        default: false
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+    paths:
+      - 'requests/fork/*.yml'
+      - 'requests/fork/*.yaml'
+
+env:
+  ROOT_DIR: "./requests/fork"
+  SCRIPTS_DIR: ".github/workflows/scripts/fork"
+  GITHUB_ACTOR: ${{ github.actor }}
+  GITHUB_PR: ${{ github.event.number }}
+  GITHUB_ORG: "wayfair-contribs"
+  LICENSE_STRING: "0bsd\napache-2.0\nbsd-2-clause\nbsd-3-clause\nmit"
 
 jobs:
-  run:
+  demo:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - uses: wayfair-incubator/forker@v0.0.5
-        name: "⑂ fork request"
         with:
-          # Enforce current list of OSPO-approved licenses
-          licenseAllowlist: "0bsd\napache-2.0\nbsd-2-clause\nbsd-3-clause\nmit" 
-          # Using API token for lhasa-ospo service account
+          ref: ${{ github.event.pull_request.head.ref }}
+      - name: 🍠 lint yaml
+        uses: ibiqlik/action-yamllint@v3
+        with:
+          file_or_dir: 'requests/fork/**'
+          config_file: '.yamllint.yml'
+      - name: 📑 parse request
+        run: ${SCRIPTS_DIR}/parse.sh
+        shell: bash
+      - name: 🚨 handle error
+        if: ${{ failure() }}
+        uses: actions/github-script@v6
+        with:
+          github-token: ${{ secrets.OSPO_API_TOKEN }}
+          script: |
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: "🚨 Hey @${{ env.GITHUB_ACTOR }}, looks like there was an issue processing your fork request! \
+              Please ensure you've committed a properly-formatted YAML (`.yml`) file to the `requests/fork/` directory."
+            })
+      - name: ✅ approve PR
+        if: ${{ success() }}
+        # Using contribs fork to make action compliant with migration to node v16
+        uses: wayfair-contribs/auto-approve-action@update-actions-runner-node
+        with:
+          github-token: ${{ secrets.OSPO_API_TOKEN }}
+      - name: 🚀 create fork
+        # Using forker release which sets output value for forkUrl
+        uses: wayfair-incubator/forker@v0.0.6
+        with:
           token: ${{ secrets.OSPO_API_TOKEN }}
-          # Manual user inputs from workflow dispatch
-          repo:  ${{ github.event.inputs.repo }}
-          owner: ${{ github.event.inputs.owner }}
-          org: ${{ github.event.inputs.org }}
-          user: ${{ github.event.inputs.user }}
-          checkUser: ${{ github.event.inputs.checkUser }}
-          promoteUser: ${{ github.event.inputs.promoteUser }}
+          repo: ${{ env.REPO_NAME }}
+          owner: ${{ env.REPO_OWNER }}
+          org: ${{ env.GITHUB_ORG }}
+          user: ${{ env.GITHUB_USER }}
+          checkUser: true
+          promoteUser: ${{ env.PROMOTE_USER }}
+          licenseAllowlist: ${{ env.LICENSE_STRING }}
+        id: fork
+      - name: 💬 add comment
+        if: ${{ success() }}
+        uses: actions/github-script@v6
+        with:
+          github-token: ${{ secrets.OSPO_API_TOKEN }}
+          script: |
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: "🎉 All set @${{ env.GITHUB_ACTOR }}! \
+              Here's your fork: ${{ steps.fork.outputs.forkUrl }}"
+            })
+      - name: 📦 process request
+        if: ${{ success() }}
+        run: |
+          ${SCRIPTS_DIR}/move.sh
+          ${SCRIPTS_DIR}/push.sh
+        shell: bash

.github/workflows/lint.yml

@@ -24,11 +24,3 @@ jobs:
         uses: suzuki-shunsuke/github-action-renovate-config-validator@v0.1.2
         with:
           config_file_path: 'renovate.json'
-  yaml:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: 🍠 lint yaml requests # Validates user-submitted YAML (.yml) files
-        uses: ibiqlik/action-yamllint@v3
-        with:
-          file_or_dir: 'requests/**/*.yml'

.github/workflows/manual.yml

@@ -0,0 +1,46 @@
+name: manual
+
+on: # Only trigger on manual input
+  workflow_dispatch:
+    inputs:
+      owner:
+        description: 'Owner of GitHub repo to be forked'
+        required: true
+      repo:
+        description: 'GitHub repo to be forked'
+        required: true
+      org:
+        description: 'GitHub org to fork the repo into'
+        required: true
+        default: wayfair-contribs
+      user:
+        description: 'GitHub user requesting the fork'
+        required: true
+      checkUser:
+        description: 'Enforce organization membership for GitHub user?'
+        required: true
+        default: true
+      promoteUser:
+        description: 'Promote GitHub user to admin of the forked repo?'
+        required: true
+        default: false
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: wayfair-incubator/forker@v0.0.5
+        name: "⑂ fork request"
+        with:
+          # Enforce current list of OSPO-approved licenses
+          licenseAllowlist: "0bsd\napache-2.0\nbsd-2-clause\nbsd-3-clause\nmit" 
+          # Using API token for lhasa-ospo service account
+          token: ${{ secrets.OSPO_API_TOKEN }}
+          # Manual user inputs from workflow dispatch
+          repo:  ${{ github.event.inputs.repo }}
+          owner: ${{ github.event.inputs.owner }}
+          org: ${{ github.event.inputs.org }}
+          user: ${{ github.event.inputs.user }}
+          checkUser: ${{ github.event.inputs.checkUser }}
+          promoteUser: ${{ github.event.inputs.promoteUser }}

.github/workflows/scripts/fork/move.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+echo "Processing user-submitted YAML file: ${REQUEST_FILE}"
+BASE_FILE=$(basename ${REQUEST_FILE})
+REPO_NAME="${BASE_FILE%.*}"
+TARGET_DIR="./${GITHUB_ORG}/${REPO_NAME}"
+mkdir -p "${TARGET_DIR}"
+
+echo "Moving YAML file to destination: ${TARGET_DIR}"
+git mv ${REQUEST_FILE} ${TARGET_DIR}

.github/workflows/scripts/fork/parse.sh

@@ -0,0 +1,47 @@
+#!/bin/bash
+
+YAML_FILE=$(find ${ROOT_DIR} -type f -maxdepth 1 \( -iname \*.yml -o -iname \*.yaml \))
+
+# Find uncategorized YAML files added to the ./requests directory
+echo ${YAML_FILE} | grep .
+# Only proceed if valid YAML files are found
+if [ "$?" -eq 0 ]; then
+    export REQUEST_FILE="${YAML_FILE}"
+    echo "REQUEST_FILE=${REQUEST_FILE}" >> $GITHUB_ENV
+    echo "Found request file to process: ${REQUEST_FILE}"
+else
+    echo "No YAML files to process! Exiting..."
+    exit 1
+fi
+
+# Extract single value from YAML key
+function get_yaml_value {
+    yq $1 $REQUEST_FILE
+}
+
+# Derive constants from yq values
+GITHUB_USER=$(get_yaml_value '.github_user')
+REPO_OWNER=$(get_yaml_value '.repo_owner')
+REPO_NAME=$(get_yaml_value '.repo_name')
+REPO_URL="https://github.com/${REPO_OWNER}/${REPO_NAME}"
+PROMOTE_USER=$(get_yaml_value '.admin_perms')
+
+# Assert user filing PR is the user defined in YAML
+if [[ "${GITHUB_USER}" == "${GITHUB_ACTOR}" ]]; then
+    echo "GITHUB_USER=${GITHUB_USER}" >> $GITHUB_ENV
+else
+    echo "GitHub username does not match PR author! Got '${GITHUB_USER},' expected '${GITHUB_ACTOR}'"
+    exit 1
+fi
+
+# Confirm owner + repo data form a valid repository URL 
+if [ $(curl -s -o /dev/null -w "%{http_code}" ${REPO_URL}) -eq 200 ]; then
+    echo "REPO_OWNER=${REPO_OWNER}" >> $GITHUB_ENV
+    echo "REPO_NAME=${REPO_NAME}" >> $GITHUB_ENV
+else
+    echo "Unable to verify repository URL! Tried: https://github.com/${REPO_OWNER}/${REPO_NAME}"
+    exit 1
+fi
+
+# Propagate user permissions value to env
+echo "PROMOTE_USER=${PROMOTE_USER}" >> $GITHUB_ENV

.github/workflows/scripts/fork/push.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# Configure git to leave PR comments as the lhasa-ospo service account
+BOT_USER="lhasa-ospo"
+BOT_EMAIL="ossdev@wayfair.com"
+
+git config --local user.name ${BOT_USER}
+git config --local user.email ${BOT_EMAIL}
+git commit -m "Process ${GITHUB_ACTOR}'s request (PR #${GITHUB_PR})"
+git push

.gitignore

@@ -1 +1,2 @@
 .vscode
+.DS_Store

.yamllint.yml

@@ -0,0 +1,7 @@
+---
+extends: default
+
+rules:
+  truthy:
+    allowed-values: ['true', 'false', 'on']
+ignore: requests/**/*.md

README.md

@@ -12,11 +12,15 @@ Automation workflows for Wayfair's [Open Source Program Office](https://wayfair.
 
 ## Self-Service
 
-🎉 Developers who wish to fork a repository into [`/wayfair-contribs`](https://github.com/wayfair-contribs) for upstream contributions can now leverage our self-service PR workflow!
+Wayfair developers who wish to fork an open source repository into [`/wayfair-contribs`](https://github.com/wayfair-contribs) for upstream contributions can now leverage our self-service PR workflow.
 
-> 💡 Please review the **[Fork a repository README](requests/fork/README.md)** and **[Pull Request template](.github/PULL_REQUEST_TEMPLATE/fork-repo.md)** to get started.
+> 🎉 Please review the **[Fork a repository README](requests/fork/README.md)** to get started!
 
-In the first phase, requests filed as PRs will be semi-automated, with some manual verification and processing still performed by the OSPO team upon receipt. However, in the future, this workflow will become fully self-serviceable through automated PR checks and GitHub Actions-driven workflows!
+In the future, developers will also leverage PR workflows to request new projects in [`/wayfair-incubator`](https://github.com/wayfair-incubator), nominate mature projects to 'graduate' to [`/wayfair`](https://github.com/wayfair), and more.
+
+> 💡 During the beta rollout of this fully self-service workflow, you may encounter some errors or edge cases we have not accounted for yet. For any issues or feedback on using this workflow, please reach out to [Wayfair OSPO](https://wayfair.github.io) internally on Slack (`#open-source-forum`) and we can lend a hand!
+
+---
 
 ## Internal Usage