From 78c0f9651ce7624527b1635d5508d8b000b460b8 Mon Sep 17 00:00:00 2001
From: Tom Keller <kellertk@amazon.com>
Date: Mon, 11 May 2026 14:16:32 -0700
Subject: [PATCH] chore: update documentation for environment workflows

Closes #1238.
---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/README.md b/README.md
index aaf5991..bcf9121 100644
--- a/README.md
+++ b/README.md
@@ -37,6 +37,12 @@ Authenticate to AWS in GitHub Actions! Works especially well with
 
     </details>
 
+    Note: if you are running in a GitHub environment based workflow, the value
+    for the Sub claim will be different, in the form of
+    `repo:<GITHUB_ORG>/<GITHUB_REPOSITORY>:environment:<ENVIRONMENT_NAME>`.
+    Adjust the trust policy accordingly if you are using environment-based
+    workflows.
+
 3. Attach permissions to the IAM Role that allow it to access the AWS resources
     you need.
 4. Add the following to your GitHub Actions workflow: <details>