-
Notifications
You must be signed in to change notification settings - Fork 11
Remove placeholder defaults from env templates #82
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
base: main
Are you sure you want to change the base?
Conversation
Change VAR_NAME=$VAR_NAME pattern to VAR_NAME= in all sample app environment templates. The old pattern was a legacy from Docker deployments and caused literal $VAR_NAME strings to be populated at runtime when variables were not set.
3824fe4 to
6a638f3
Compare
| # 'flow' relies on the PingOne Protect collector for initialization | ||
| PINGONE_ENV_ID=$PINGONE_ENV_ID # required when ProtectCollector is present | ||
| WELLKNOWN_URL= | ||
| INIT_PROTECT= # bootstrap | flow |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm concerned if we leave comments on the same line we can run into the same problem. Can we move all comments to new lines?
| SCOPE= // For using "PINGONE" as the server type, the `revoke` scope must be set as well. | ||
| TIMEOUT= | ||
| WEB_OAUTH_CLIENT= | ||
| NX_NO_CLOUD=true |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need this?
| SCOPE=$SCOPE // For using "PINGONE" as the server type, the `revoke` scope must be set as well. | ||
| TIMEOUT=$TIMEOUT | ||
| WEB_OAUTH_CLIENT=$WEB_OAUTH_CLIENT | ||
| SCOPE= // For using "PINGONE" as the server type, the `revoke` scope must be set as well. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be # instead of //?
| REALM_PATH= | ||
| SCOPE= | ||
| TIMEOUT= | ||
| TREE= # Remove the TREE variable to use the default tree/journey |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can actually remove this comment now
| INIT_PROTECT= # bootstrap | journey | ||
| # 'bootstrap' will initialize protect at app bootstrap time | ||
| # 'journey' relies on the PingOneProtectInitialize callback for initialization | ||
| PINGONE_ENV_ID= # required when PingOne Protect callbacks are present |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we move these comments to new lines too?
| SERVER_TYPE= # 'AIC' or 'PINGONE' | ||
| SERVER_URL= # AM URL for AIC or PingOne base URL with env ID for PingOne | ||
| PORT= | ||
| REALM_PATH= # 'alpha' or 'beta' for AIC server type. Not used for PingOne. | ||
| REST_OAUTH_CLIENT= # Confidential client ID for AIC or WebApp public client ID for PingOne | ||
| REST_OAUTH_SECRET= # Confidential client secret for AIC. Not used for PingOne. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
here too
https://pingidentity.atlassian.net/browse/SDKS-4446
Summary
VAR_NAME=$VAR_NAMEpattern from all sample app environment templatesVAR_NAME=) to prevent literal$VAR_NAMEstrings from being populated at runtimeBackground
The old pattern was a legacy from when sample apps were deployed through Docker. This is no longer the case, and the placeholders caused issues when users didn't want to use a variable - the literal string
$VAR_NAMEwould be populated at runtime instead of an empty value.Changes
Updated 8
.env.examplefiles:angular-todo/.env.exampleangular-todo-davinci/.env.examplecentral-login-oidc/.env.exampleembedded-login/.env.exampleembedded-login-davinci/.env.examplereactjs-todo/.env.examplereactjs-todo-davinci/.env.exampletodo-api/.env.exampleTest plan
=$VAR_NAMEpatterns remain in codebaseNotes
External documentation that references the old
VAR_NAME=$VAR_NAMEpattern will need to be updated separately.