From 7f5e3139fe81f67e7d2816983965acb278ae6138 Mon Sep 17 00:00:00 2001 From: Michael Lehmann Date: Thu, 24 Apr 2025 12:09:12 -0700 Subject: [PATCH] Update README.md update readme.md to provide a suggestion for altering the role-session-name for easier auditability --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d95fc5e..6124862 100644 --- a/README.md +++ b/README.md @@ -131,7 +131,13 @@ with the `role-external-id` input #### Session tagging and name The default session name is "GitHubActions", and you can modify it by specifying -the desired name in `role-session-name`. The session will be tagged with the +the desired name in `role-session-name`. + +_Note: you might find it helpful to set the `role-session-name` to `${{ github.run_id }}` +so as to clarify in audit logs which AWS actions were performed by which workflow +run._ + +The session will be tagged with the following tags: (Refer to [GitHub's documentation for `GITHUB_` environment variable definitions](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/using-environment-variables#default-environment-variables))