From 714bd6957cd5260a9524bdb46bf4828d2a78c4e3 Mon Sep 17 00:00:00 2001
From: John Brunton <john_brunton@live.co.uk>
Date: Mon, 2 Jan 2023 18:33:02 +0000
Subject: [PATCH] docs: Advise setting GITHUB_TOKEN to avoid rate limits

---
 CHANGELOG.md |  1 +
 README.md    | 18 ++++++++++++++----
 2 files changed, 15 insertions(+), 4 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 38efb3ec..20518173 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,6 +1,7 @@
 # CHANGELOG
 
 - feat: Add deletion of stack after destroy (remove flag)
+- docs: Advise setting GITHUB_TOKEN to avoid rate limits
 
 --
 
diff --git a/README.md b/README.md
index f9de0a2a..7089df1e 100644
--- a/README.md
+++ b/README.md
@@ -29,6 +29,7 @@ jobs:
           stack-name: org-name/stack-name
         env:
           PULUMI_ACCESS_TOKEN: ${{ secrets.PULUMI_ACCESS_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Avoid GitHub rate limits (see below)
 ```
 
 This will check out the existing directory and run `pulumi preview`.
@@ -41,8 +42,8 @@ The action can be configured with the following arguments:
   values are `up` (update), `refresh`, `destroy` and `preview`.
 
 - `stack-name` (required) - The name of the stack that Pulumi will be operating
-  on. Use the fully quaified org-name/stack-name when operating on a stack outside
-  of your individual account.
+  on. Use the fully quaified org-name/stack-name when operating on a stack
+  outside of your individual account.
 
 - `work-dir` (optional) - The location of your Pulumi files. Defaults to `./`.
 
@@ -105,8 +106,8 @@ The action can be configured with the following arguments:
   `Pulumi.<stack-name>.yaml` file that you will need to add back to source
   control as part of the action if you wish to perform any further tasks with
   that stack.
-- `remove` - (optional) Removes the target stack if all resources are
-  destroyed. Used only with `destroy` command.
+- `remove` - (optional) Removes the target stack if all resources are destroyed.
+  Used only with `destroy` command.
 - `pulumi-version` - (optional) Install a specific version of the Pulumi CLI.
   Defaults to "^3"
 
@@ -115,6 +116,14 @@ By default, this action will try to authenticate Pulumi with the
 `PULUMI_ACCESS_TOKEN` then you will need to specify an alternative backend via
 the `cloud-url` argument.
 
+If you are using any Pulumi plugins then you should also set the `GITHUB_TOKEN`
+environment variable in order to avoid hitting GitHub rate limits. The easiest
+way to do this is to set it to the automatically created
+`${{ secrets.GITHUB_TOKEN }}`. (The GitHub docs provide more details regarding
+[automatic token authentication](https://docs.github.com/en/actions/security-guides/automatic-token-authentication)
+and
+[rate limits](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting).)
+
 ### Stack Outputs
 
 [Stack outputs](https://www.pulumi.com/docs/intro/concepts/stack/#outputs) are
@@ -148,6 +157,7 @@ action, we would use code similar to the following:
   id: pulumi
   env:
     PULUMI_CONFIG_PASSPHRASE: ${{ secrets.PULUMI_CONFIG_PASSPHRASE }}
+    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
   with:
     command: up
     cloud-url: gs://my-bucket