Skip to content

Commit

Permalink
feat: improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hertzsprung committed Oct 14, 2023
1 parent 583fcee commit 48f10a4
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion src/oidc-provider.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,17 @@ export interface GitHubActionRoleProps {
* A list of GitHub repositories you want to be able to access the IAM role.
* Each entry should be your GitHub username and repository passed in as a
* single string.
* An entry `owner/repo` is equivalent to the subjectClaim `repo:owner/repo:*`.
*
* For example, `['owner/repo1', 'owner/repo2'].
*/
readonly repos?: string[];

/**
* A list of subject claims.
* A list of subject claims allowed to access the IAM role.
* See https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect
* A subject claim can include `*` and `?` wildcards according to the `StringLike`
* condition operator.
*
* For example, `['repo:owner/repo1:ref:refs/heads/branch1', 'repo:owner/repo1:environment:prod']`
*/
Expand Down

0 comments on commit 48f10a4

Please sign in to comment.