aws-actions/configure-aws-credentials
1
0
Fork 0
mirror of https://github.com/aws-actions/configure-aws-credentials.git synced 2026-09-04 06:15:07 +09:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1008 from aws-actions/kellertk-patch-1

Browse Source 
chore: fix README typos
This commit is contained in:
Tim Finnigan
2024-02-16 11:11:35 -08:00
committed by GitHub
parent 5393920a08 c754bf3531
commit e821ee1878
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6 -6
View File
@@ -31,7 +31,7 @@ For more information on how to do that, read on.
### Note about GHES ### Note about GHES
Some of this documentation may be inaccurate if you are using GHES (GitHub Some of this documentation may be inaccurate if you are using GHES (GitHub
Enterprise Servers), please take note to review the GitHub documentation when Enterprise Server), please take note to review the GitHub documentation when
relevant. relevant.
For example, the URL that the OIDC JWT is issued from is different than the For example, the URL that the OIDC JWT is issued from is different than the
@@ -56,7 +56,7 @@ for the AWS credentials used in GitHub Actions workflows, including:
* [Monitor the activity](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#keep-a-log) * [Monitor the activity](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#keep-a-log)
of the credentials used in GitHub Actions workflows. of the credentials used in GitHub Actions workflows.
* Use temporary credentials when possible. * Use temporary credentials when possible.
* Peridically rotate any long-term credentials you use. * Periodically rotate any long-term credentials you use.
## Using this action ## Using this action
There are five different supported ways to retrieve credentials: There are five different supported ways to retrieve credentials:
@@ -87,9 +87,9 @@ based on which values are supplied to the Action:
| Assume Role using WebIdentity Token File credentials | | ✔ | ✔ | | | | Assume Role using WebIdentity Token File credentials | | ✔ | ✔ | | |
| Assume Role using existing credentials | | ✔ | | ✔ | | | Assume Role using existing credentials | | ✔ | | ✔ | |
*Note: `role-chaining` is not necessary to use existing credentials in every use *Note: `role-chaining` is not always necessary to use existing credentials.
case. If you're getting a "Credentials loaded by the SDK do not match" error, If you're getting a "Credentials loaded by the SDK do not match" error,
try enabling this option. try enabling this option.*
### Options ### Options
See [action.yml](./action.yml) for more detail. See [action.yml](./action.yml) for more detail.
@@ -243,7 +243,7 @@ If you set the `special-characters-workaround` option, this action will
continually retry fetching credentials until we get one that does not have continually retry fetching credentials until we get one that does not have
special characters. This option overrides the `disable-retry` and special characters. This option overrides the `disable-retry` and
`retry-max-attempts` options. We recommend that you do not enable this option `retry-max-attempts` options. We recommend that you do not enable this option
unless required, because retrying API infinitely until they succeed is not best unless required, because retrying APIs infinitely until they succeed is not best
practice. practice.
## OIDC ## OIDC