From 28a818be69fe2838d577205e53c9e8c411e68e20 Mon Sep 17 00:00:00 2001 From: Nafisa Tabassum Date: Thu, 6 Jun 2024 10:41:22 -0600 Subject: [PATCH] docs(aws auth): Mention `event_name` in passed claims (#144) --- actions/aws-auth/README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/actions/aws-auth/README.md b/actions/aws-auth/README.md index 702073a2..79123852 100644 --- a/actions/aws-auth/README.md +++ b/actions/aws-auth/README.md @@ -22,7 +22,7 @@ jobs: with: aws-region: "us-west-1" role-arn: "arn:aws:iam::366620023056:role/github-actions/s3-test-access" - pass-claims: "repository_owner, repository_name, job_workflow_ref" + pass-claims: "repository_owner, repository_name, job_workflow_ref, event_name" set-creds-in-environment: true - id: cat-file-from-s3-bucket @@ -35,13 +35,13 @@ jobs: -| Name | Type | Description | -| -------------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `aws-region` | String | Specify AWS region to use that contain your resources (default: `us-east-2`) | -| `role-arn` | String | Specify custom workload role. Role ARN must be prefixed with `github-actions` e.g. `arn:aws:iam::366620023056:role/github-actions/s3-test-access` [^1] | -| `pass-claims` | String | `, `-separated list of [GitHub Actions claims](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#understanding-the-oidc-token) (session tags) to make available to `role-arn`. Currently supported claims (default): `"repository_owner, repository_name, job_workflow_ref"` [^2] | -| `set-creds-in-environment` | Bool | Set environment variables for AWS CLI and SDKs (default: `true`) | -| `role-duration-seconds` | String | Role duration in seconds (default: `"3600"`) | +| Name | Type | Description | +| -------------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `aws-region` | String | Specify AWS region to use that contain your resources (default: `us-east-2`) | +| `role-arn` | String | Specify custom workload role. Role ARN must be prefixed with `github-actions` e.g. `arn:aws:iam::366620023056:role/github-actions/s3-test-access` [^1] | +| `pass-claims` | String | `, `-separated list of [GitHub Actions claims](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#understanding-the-oidc-token) (session tags) to make available to `role-arn`. Currently supported claims (default): `"repository_owner, repository_name, job_workflow_ref, event_name"` [^2] | +| `set-creds-in-environment` | Bool | Set environment variables for AWS CLI and SDKs (default: `true`) | +| `role-duration-seconds` | String | Role duration in seconds (default: `"3600"`) |