update README.md

Author: kitemongerer

README.md

@@ -1,7 +1,6 @@
-# Example Webhook Receiver
+# Example to Trigger GitHub Actions from a Render Webhook
 
-This basic example receives webhooks and logs the payload.
-It will fetch service, Postgres, or Key Value store information from the RENDER API for certain webhook types.
+This example triggers a GitHub Action workflow when a deploy ended webhook is received for a specific service.
 
 ## Deploy to Render
 
@@ -10,5 +9,13 @@ It will fetch service, Postgres, or Key Value store information from the RENDER
 
 2. Follow [instructions](https://render.com/docs/webhooks) to create a webhook with the URL from your service and `/webhook` path
 3. Follow [instructions](https://render.com/docs/api#1-create-an-api-key) to create a Render API Key
-4. Set `RENDER_WEBHOOK_SECRET` environment variable to the secret from the webhook created in step 2. SET `RENDER_API_KEY` to the key created in step 3.
-5. Trigger a service deploy and watch the webhooks roll in.
+4. Follow [instructions](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) to create a GitHub api token with read/write permissions for `Actions`
+5. Create a github workflow with a dispatch trigger as shown in the [example](./.github/workflows/example.yaml)
+6. Set the following env vars
+   - `RENDER_WEBHOOK_SECRET` environment variable to the secret from the webhook created in step 2
+   - `RENDER_API_KEY` to the key created in step 3
+   - `GITHUB_API_TOKEN` to the token created in step 4
+   - `GITHUB_OWNER_NAME` to the owner of the GitHub repo the workflow is in (ex. `render-examples`)
+   - `GITHUB_REPO_NAME` to the GitHub repo the workflow is in (ex. `webhook-github-action`)
+   - `GITHUB_WORKFLOW_ID` to the ID or filename of the workflow to trigger (ex. `example.yaml`)
+7. Trigger a service deploy and watch the GitHub workflow get triggered.

app.ts

@@ -11,7 +11,7 @@ const renderAPIURL = process.env.RENDER_API_URL || "https://api.render.com/v1"
 // To create a Render API token, follow instructions here: https://render.com/docs/api#1-create-an-api-key
 const renderAPIToken = process.env.RENDER_API_TOKEN || '';
 
-const githubAPIToken = process.env.GITHUB_TOKEN || '';
+const githubAPIToken = process.env.GITHUB_API_TOKEN || '';
 const githubOwnerName = process.env.GITHUB_OWNER_NAME || '';
 const githubRepoName = process.env.GITHUB_REPO_NAME || '';
 const githubWorkflowID = process.env.GITHUB_WORKFLOW_ID || 'example.yaml';

render.yaml

@@ -6,10 +6,10 @@ services:
   branch: create-webhook-github-action
   plan: starter
   envVars:
-  - key: RENDER_API_TOKEN
-    sync: false
   - key: RENDER_WEBHOOK_SECRET
     sync: false
+  - key: RENDER_API_KEY
+    sync: false
   region: oregon
   buildCommand: pnpm install && pnpm run build
   startCommand: pnpm run start