Merge pull request #3 from evvanErb/loginAndRequest

Token Auth as Primary Retreival Method

Author: Evvan Erb

.github/workflows/automated_testing.yml

@@ -10,6 +10,20 @@ jobs:
   get_easy_email:
     runs-on: ubuntu-latest
     name: Get an easy to find email
+    steps:
+      - name: get easy email
+        id: get_easy_email_test
+        uses: evvanErb/get-github-email-by-username-action@main
+        with:
+          github-username: 'evvanErb'
+          token: ${{ secrets.BOT_TOKEN }}
+
+      - name: Echo the output email
+        run: echo "The email is ${{ steps.get_easy_email_test.outputs.email }}"
+
+  get_easy_email_bad_token:
+    runs-on: ubuntu-latest
+    name: Get an easy to find email bad token
     steps:
       - name: get easy email
         id: get_easy_email_test
@@ -29,6 +43,21 @@ jobs:
         uses: evvanErb/get-github-email-by-username-action@main
         with:
           github-username: 'highly0'
+          token: ${{ secrets.BOT_TOKEN }}
+
+      - name: Echo the output email
+        run: echo "The email is ${{ steps.get_email_after_bot_test.outputs.email }}"
+
+  get_email_only_userpage_no_events:
+    runs-on: ubuntu-latest
+    name: Get an email listed on a user's page but not in events
+    steps:
+      - name: get email after bot
+        id: get_email_after_bot_test
+        uses: evvanErb/get-github-email-by-username-action@main
+        with:
+          github-username: 'jaronson13'
+          token: ${{ secrets.BOT_TOKEN }}
 
       - name: Echo the output email
         run: echo "The email is ${{ steps.get_email_after_bot_test.outputs.email }}"
@@ -42,6 +71,7 @@ jobs:
         uses: evvanErb/get-github-email-by-username-action@main
         with:
           github-username: 'hstought'
+          token: ${{ secrets.BOT_TOKEN }}
 
       - name: Echo the output email (Should not run)
         run: echo "The email is ${{ steps.fail_bad_email_test.outputs.email }}"
@@ -55,6 +85,7 @@ jobs:
         uses: evvanErb/get-github-email-by-username-action@main
         with:
           github-username: 'evvvvvaaannnnneeerrrbbb'
+          token: ${{ secrets.BOT_TOKEN }}
 
       - name: Echo the output email (Should not run)
         run: echo "The email is ${{ steps.get_email_after_bot_test.outputs.email }}"

README.md

@@ -3,7 +3,7 @@ GitHub Actions Plugin to get a GitHub user's email based on their username
 
 ## Usage
 
-Takes in a username as a required input, queries Github's API to find all public event related to a user, then finds their email in the API response and returns it. The user must have made a commit to a public repo during the current calendar year and have their email exposed to the public in their settings.
+Takes in a username as a required input and a personal access token as an optional input. If a personal access token (does not matter whose) is provided, it queries Github's Users API to find the public info available for the provided username in order to get their email. If this fails, or no auth token is provided, it attempts to search all public event related to a user, then tries to find their email in the API response and return it (fallback / no auth token method). For the fallback / no auth token method, a user must have made a commit to a public repo during the current calendar year and have their email exposed to the public in their settings.
 
 ## Example
 ```
@@ -21,6 +21,7 @@ jobs:
         uses: evvanErb/get-github-email-by-username-action@v1.25
         with:
           github-username: 'evvanErb' # This is the input username
+          token: 'token' # This is an optional input of a PAT to use a more reliable way to get a user's email
           
       # Use the output from the `test` step
       - name: Print the found email

action.yml

@@ -1,10 +1,17 @@
 name: 'Get GitHub Email from Username'
 description: 'Get a GitHub users email address'
 inputs:
+
   github-username:  # id of input
     description: 'Username to get email for'
     required: true
     default: 'evvanErb'
+
+  token:  # id of input
+    description: 'Token to login to get email'
+    required: false
+    default: ''
+
 outputs:
   email: # id of output
     description: 'The email found'

dist/303.index.js

@@ -10,8 +10,8 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony export */ __webpack_require__.d(__webpack_exports__, {
 /* harmony export */   "toFormData": () => (/* binding */ toFormData)
 /* harmony export */ });
-/* harmony import */ var fetch_blob_from_js__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(870);
-/* harmony import */ var formdata_polyfill_esm_min_js__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(253);
+/* harmony import */ var fetch_blob_from_js__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(7870);
+/* harmony import */ var formdata_polyfill_esm_min_js__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(2253);