Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Trust policy example in Setting up OIDC for AWS should reference docs on OIDC subjects in claims #28292

Closed
1 task done
therealvio opened this issue Sep 17, 2023 · 3 comments
Closed
1 task done
Labels
content This issue or pull request belongs to the Docs Content team

Comments

@therealvio
Copy link

therealvio commented Sep 17, 2023

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services

What changes are you suggesting?

In the first example for this section of the doc, the trust policy scopes the access to a particular branch for a repository using ref as a subject.

However, this example doesn't make note of a pitfall where if a job references a Deployment Environment then the policy won't allow Github Actions to assume the role. In my case, I had a deploy script reference a production environment. So I needed to set the policy use to environment as a claim, as depicted here.

This is something that was tricky to figure out until I ran into the claims doc above.

Additional information

I raised a draft PR for this, though unfortunately this area of the documentation is restricted. Though I thought I'd leave it so it can be copied over and extended.

@therealvio therealvio added the content This issue or pull request belongs to the Docs Content team label Sep 17, 2023
@welcome
Copy link

welcome bot commented Sep 17, 2023

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team. label Sep 17, 2023
@cmwilson21 cmwilson21 removed the triage Do not begin working on this issue until triaged by the team. label Sep 18, 2023
@cmwilson21
Copy link
Contributor

@therealvio thank you for opening an issue and submitting a PR!

@cmwilson21
Copy link
Contributor

Closing this per comment here. It was fixed internally

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants