feat(get-email-on-user-profile): add get-email-on-user-profile helper

.github/workflows/get-email-on-user-profile.yml

@@ -0,0 +1,22 @@
+name: Get Email on User Profile
+
+on:
+  pull_request:
+    branches: [main]
+    paths:
+      - 'src/helpers/get-email-on-user-profile.ts'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - uses: ./
+        id: get-email-on-user-profile
+        with:
+          helper: get-email-on-user-profile
+          login: ${{ github.actor }}
+
+      - run: echo "Email is ${{ steps.get-email-on-user-profile.outputs.output }}"

README.md

@@ -46,6 +46,10 @@ with:
 
 Each of the following helpers are defined in a file of the same name in `src/helpers`:
 
+### [get-email-on-user-profile](.github/workflows/get-email-on-user-profile.yml)
+
+- Retrieves a user's github email with optional regex verification
+
 ### [get-merge-queue-position](.github/workflows/get-merge-queue-position.yml)
 
 - Returns the current position of a given PR in the GitHub merge queue