Use consistent format for placeholders in Open ID section #34454
Conversation
github-actions
bot
added
the
triage
Automatically generated comment ℹ️This comment is automatically generated and will be overwritten every time changes are committed to this branch. The table contains an overview of files in the Content directory changesYou may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request. fpt: Free, Pro, Team |
| * `<example-aws-region>`: Add the name of your AWS region here. | ||
| * `BUCKET-NAME`: Add the name of your S3 bucket here. | ||
| * `AWS-REGION`: Add the name of your AWS region here. | ||
| * `ROLE-TO-ASSUME`: Replace this with your AWS role. For example, `arn:aws:iam::1234567890:role/example-role` |
There was a problem hiding this comment.
Made <role-to-assume> a placeholder ROLE-TO-ASSUME with an example, and referenced that in the YAML file similar to what's in GCP documentation:
| @@ -59,9 +59,8 @@ The `google-github-actions/auth` action receives a JWT from the {% data variable | |||
|
|
|||
| This example has a job called `Get_OIDC_ID_token` that uses actions to request a list of services from GCP. | |||
|
|
|||
| * `<example-workload-identity-provider>`: Replace this with the path to your identity provider in GCP. For example, `projects/<example-project-id>/locations/global/workloadIdentityPools/<name-of-pool>/providers/<name-of-provider>` | |||
| * `<example-service-account>`: Replace this with the name of your service account in GCP. | |||
| * `<project-id>`: Replace this with the ID of your GCP project. | |||
There was a problem hiding this comment.
The entire <project-id> line is removed as there is no reference in the YAML to this.
hsnabszhdn
force-pushed
the
use-consistent-naming-for-placeholders
branch
from
44e5fa2
to
d862229
Compare
hsnabszhdn
changed the title
This comment was marked as spam.
This comment was marked as spam.
nguyenalex836
added
content
|
@hsnabszhdn Thanks so much for opening a PR with these fixes! I'll update the branch and get this merged once tests are passing 🍏 |
nguyenalex836
removed
the
waiting for review
|
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡ |
Why:
GitHub's style guide uses hyphenated all caps for placeholders:
Closes: N/A
What's being changed (if available, include any code snippets, screenshots, or gifs):
<some-placeholder>/<Some Placeholder>/<somePlaceholder>change toSOME-PLACEHOLDER<example-placeholder>is changed toPLACEHOLDERas they are not an "example", but a placeholder for an example, if you get what I mean! 😅<>are being removed fromprojects/<example-project-id>/locations/global/workloadIdentityPools/<name-of-pool>/providers/<name-of-provider>as these ones are actual examples, not placeholders<project-id>placeholder is being removed from the GCP documentation as there is no reference in the YAML file to that placeholder (see the comment in the "Files changed" tab)ROLE-TO-ASSUMEis being added to the AWS documentation as the example in GCP uses a placeholder instead of hard-coding the example in the YAML file (see the comment/screenshot in the "Files changed" tab)Check off the following:
I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).
datadirectory.For content changes, I have completed the self-review checklist.