Skip to content

Commit 32a3a7c

Browse files
committed
chore: add table of contents to README
1 parent 35a0f3f commit 32a3a7c

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,21 @@
22

33
Configure AWS credential and region environment variables for use in other GitHub Actions. The environment variables will be detected by both the AWS SDKs and the AWS CLI to determine the credentials and region to use for AWS API calls.
44

5+
**Table of Contents**
6+
7+
<!-- toc -->
8+
9+
- [Usage](#usage)
10+
- [Credentials](#credentials)
11+
- [Assuming a Role](#assuming-a-role)
12+
+ [Permissions for assuming a role](#permissions-for-assuming-a-role)
13+
+ [Session tagging](#session-tagging)
14+
- [Self-Hosted Runners](#self-hosted-runners)
15+
- [License Summary](#license-summary)
16+
- [Security Disclosures](#security-disclosures)
17+
18+
<!-- tocstop -->
19+
520
## Usage
621

722
Add the following step to your workflow:
@@ -50,7 +65,7 @@ We recommend following [Amazon IAM best practices](https://docs.aws.amazon.com/I
5065
* [Rotate the credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#rotate-credentials) used in GitHub Actions workflows regularly.
5166
* [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.
5267
53-
## Assuming a role
68+
## Assuming a Role
5469
If you would like to use the static credentials you provide to this action to assume a role, you can do so by specifying the role ARN in `role-to-assume`.
5570
The role credentials will then be configured in the Actions environment instead of the static credentials you have provided.
5671
The default session duration is 6 hours, but if you would like to adjust this you can pass a duration to `role-duration-seconds`.
@@ -130,7 +145,7 @@ The session will have the name "GitHubActions" and be tagged with the following
130145

131146
_Note: all tag values must conform to [the requirements](https://docs.aws.amazon.com/STS/latest/APIReference/API_Tag.html). Particularly, `GITHUB_WORKFLOW` will be truncated if it's too long. If `GITHUB_ACTOR` or `GITHUB_WORKFLOW` contain invalid charcters, the characters will be replaced with an '*'._
132147

133-
## Self-hosted runners
148+
## Self-Hosted Runners
134149

135150
If you run your GitHub Actions in a [self-hosted runner](https://help.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners) that already has access to AWS credentials, such as an EC2 instance, then you do not need to provide IAM user access key credentials to this action.
136151

@@ -156,3 +171,7 @@ In this case, your runner's credentials must have permissions to assume the role
156171
## License Summary
157172

158173
This code is made available under the MIT license.
174+
175+
## Security Disclosures
176+
177+
If you would like to report a potential security issue in this project, please do not create a GitHub issue. Instead, please follow the instructions [here](https://aws.amazon.com/security/vulnerability-reporting/) or [email AWS security directly](mailto:[email protected]).

0 commit comments

Comments
 (0)