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

Adds note about Sub ID bug #1528

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions aws-py-oidc-provider-pulumi-cloud/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,19 @@ You can configure more granular access control by adding the `sub` claim to the
]
}
```

{{< notes type="warning" >}}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This a Hugo shortcode expression, so it won't render properly outside of our website (e.g., in this GitHub repo). We should adjust it to be regular GitHub-flavored Markdown.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @cnunciato,

Doesn't this get funneled into the registry? I think this is why I included it if I remember correctly. What's the best way to highlight this in both places?

Copy link
Contributor

@cnunciato cnunciato Mar 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the delayed response! I completely missed this.

It does, but we want it to render properly on GitHub also. Right now, it looks like this:

image

Best thing would probably be to use a regular heading and paragraph to call attention to it. Folks sometimes use blockquotes for things like this (> in Markdown), but I don't recommend them, as they're not a good fit semantically. (They're more meant for quotes or citations.)


If you are integrating Pulumi ESC with Pulumi IaC, using the specific name of the ESC environment in the subject identifier will not work at this time. There is a [known issue](https://github.com/pulumi/pulumi/issues/14509) with the value of the subject identifier that is sent to the provider from Pulumi.

The steps in this guide will work for Pulumi ESC if you use the following syntax instead:

`pulumi:environments:org:<your-pulumi-org>:env:<yaml>`

Make sure to replace `<your-pulumi-org>` with the name of your Pulumi organization and use the literal value of `<yaml>` as shown above.

{{< /notes >}}

Once you are done, you can destroy all of the resources as well as the stack:

```bash
Expand Down
Loading