search

org-formation / org-formation-cli

Better than landingzones!
MIT License
1.41k stars 131 forks source link

Clarification DefaultBuildAccessRoleName vs DefaultBuildProcessAccessRoleName #515

Closed k-paulius closed 1 year ago

k-paulius commented 1 year ago

Hi, @OlafConijn, could you please clarify the difference between DefaultBuildAccessRoleName and DefaultBuildProcessAccessRoleName. Are they essentially the same thing?

DefaultBuildProcessAccessRoleName is documented in organization-resources.md. DefaultBuildAccessRoleName is used in the generated organization.yml, but not documented. And code refers to both properties.

Thanks!

OlafConijn commented 1 year ago

thanks for calling this out @k-paulius.

the DefaultBuildProcessAccessRoleName in indeed an internal name and should not have appeared in the docs. I fixed this in the following commit: https://github.com/org-formation/org-formation-cli/compare/4d42466db20c...db3ae5ff8d48

k-paulius commented 1 year ago

Appreciate you clarifying that @OlafConijn.

This is a bit unrelated, but I also noticed that TaskViaRoleArn is not documented. Am I correct in assuming that TaskViaRoleArn is assumed before assuming TaskRoleName (or DefaultBuildAccessRoleName if TaskRoleName is not defined).

OlafConijn commented 1 year ago

exactly right

k-paulius commented 1 year ago

Thanks again @OlafConijn, I submitted pull request to document that.