feat: configure local workflow (#1)

* feat: trigger test workflow on PR

* feat: adding logic to connect to URL via PR number

* feat: adding the ability to adjust the timeout

* feat: updating README

Author: JakePartusch

.github/workflows/main.yml

@@ -1,20 +1,15 @@
-on: [push]
+on: [pull_request]
 
 jobs:
-  hello_world_job:
+  wait_for_netlify:
     runs-on: ubuntu-latest
     name: A job to test this action
     steps:
-      # To use this repository's private action, you must check out the repository
       - name: Checkout
         uses: actions/checkout@v1
       - name: Waiting for 200 response
         uses: ./ # Uses an action in the root directory
         id: waitFor200
         with:
-          url: "https://jake.partus.ch"
-      - name: Should timeout for non-existant url
-        uses: ./ # Uses an action in the root directory
-        id: waitFor404
-        with:
-          url: "https://askldsdjklflkjasdf.com"
+          site_name: "jakepartusch"
+          max_timeout: 60

README.md

@@ -1,21 +1,25 @@
-# Hello world javascript action
+# Wait for Netlify GitHub Action 🎉
 
-This action prints "Hello World" or "Hello" + the name of a person to greet to the log.
+Do you have other Github actions (Lighthouse, Cypress, etc) that depend on the Netlify Preview URL? This action will wait until the url is available before running the next task.
 
 ## Inputs
 
-### `who-to-greet`
+### `site_name`
 
-**Required** The name of the person to greet. Default `"World"`.
+**Required** The name of the Netlify site to reach `https://{site_name}.netlify.com`
 
-## Outputs
+### `max_timeout`
 
-### `time`
-
-The time we greeted you.
+Optional — The amount of time to spend waiting on Netlify. Defaults to `60` seconds
 
 ## Example usage
 
-uses: actions/hello-world-javascript-action@v1
-with:
-who-to-greet: 'Mona the Octocat'
+```
+steps:
+  - name: Waiting for 200 from the Netlify Preview
+    uses: actions/wait-for-netlify-action@v1
+    id: waitFor200
+    with:
+      site_name: "jakepartusch"
+      max_timeout: 60
+```

index.js

@@ -2,27 +2,28 @@ const core = require("@actions/core");
 const github = require("@actions/github");
 const axios = require("axios");
 
-const waitForUrl = async url => {
-  for (let i = 0; i < 5; i++) {
+const waitForUrl = async (url, MAX_TIMEOUT) => {
+  const iterations = MAX_TIMEOUT / 2;
+  for (let i = 0; i < iterations; i++) {
     try {
       await axios.get(url);
+      return;
     } catch (e) {
-      await new Promise(r => setTimeout(r, 5000));
-      if (i === 4) {
-        core.setFailed(`Timeout reached: Unable to connect to ${url}`);
-      }
+      console.log("Url unavailable, retrying...");
+      await new Promise(r => setTimeout(r, 2000));
     }
   }
+  core.setFailed(`Timeout reached: Unable to connect to ${url}`);
 };
 
 const run = async () => {
   try {
-    const url = core.getInput("url");
+    const PR_NUMBER = github.context.payload.number;
+    const MAX_TIMEOUT = Number(core.getInput("site_name")) || 60;
+    const siteName = core.getInput("site_name");
+    const url = `https://deploy-preview-${PR_NUMBER}--${siteName}.netlify.com`;
     console.log(`Waiting for a 200 from: ${url}`);
-    await waitForUrl(url);
-    // Get the JSON webhook payload for the event that triggered the workflow
-    const payload = JSON.stringify(github.context.payload, undefined, 2);
-    console.log(`The event payload: ${payload}`);
+    await waitForUrl(url, MAX_TIMEOUT);
   } catch (error) {
     core.setFailed(error.message);
   }