Address Lucas's feedback about auth docs and superfluous line in test

hashicorp · Jun 4, 2024 · 90c5c1e · 90c5c1e
1 parent b1d6ef9
commit 90c5c1e
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 10 deletions.
diff --git a/.web-docs/README.md b/.web-docs/README.md
@@ -44,9 +44,12 @@ Packer can create Azure virtual machine images through variety of ways depending
 
 Config allows for various ways to authenticate Azure clients.  When
 `client_id` and `subscription_id` are specified in addition to one of the following
-`client_secret`, `client_jwt`, `client_cert_path`, or `oidc_request_url combined with oidc_request_token` --
-Packer will use the specified Azure Active Directory (AAD) Service Principal
-(SP).
+* `client_secret`
+* `client_jwt`
+* `client_cert_path`
+* `oidc_request_url` combined with `oidc_request_token`
+
+Packer will use the specified Azure Active Directory (AAD) Service Principal (SP).
 If none of these options are specified, Packer will attempt to use the Managed Identity
 and subscription of the VM that Packer is running on.  This will only work if
 Packer is running on an Azure VM with either a System Assigned Managed

diff --git a/builder/azure/common/client/config.go b/builder/azure/common/client/config.go
@@ -29,9 +29,12 @@ var NullModelSDKErr = fmt.Errorf("Unexpected SDK response, please open an issue
 
 // Config allows for various ways to authenticate Azure clients.  When
 // `client_id` and `subscription_id` are specified in addition to one of the following
-// `client_secret`, `client_jwt`, `client_cert_path`, or `oidc_request_url combined with oidc_request_token` --
-// Packer will use the specified Azure Active Directory (AAD) Service Principal
-// (SP).
+// * `client_secret`
+// * `client_jwt`
+// * `client_cert_path`
+// * `oidc_request_url` combined with `oidc_request_token`
+//
+// Packer will use the specified Azure Active Directory (AAD) Service Principal (SP).
 // If none of these options are specified, Packer will attempt to use the Managed Identity
 // and subscription of the VM that Packer is running on.  This will only work if
 // Packer is running on an Azure VM with either a System Assigned Managed

diff --git a/builder/azure/common/client/config_test.go b/builder/azure/common/client/config_test.go
@@ -223,7 +223,6 @@ func Test_ClientConfig_GitHubOIDC_Rejections(t *testing.T) {
 		OidcRequestURL:   "whatever",
 	}
 	assertInvalid(t, cfg)
-
 }
 
 func getEnvOrSkip(t *testing.T, envVar string) string {

diff --git a/docs-partials/builder/azure/common/client/Config.mdx b/docs-partials/builder/azure/common/client/Config.mdx
@@ -2,9 +2,12 @@
 
 Config allows for various ways to authenticate Azure clients.  When
 `client_id` and `subscription_id` are specified in addition to one of the following
-`client_secret`, `client_jwt`, `client_cert_path`, or `oidc_request_url combined with oidc_request_token` --
-Packer will use the specified Azure Active Directory (AAD) Service Principal
-(SP).
+* `client_secret`
+* `client_jwt`
+* `client_cert_path`
+* `oidc_request_url` combined with `oidc_request_token`
+
+Packer will use the specified Azure Active Directory (AAD) Service Principal (SP).
 If none of these options are specified, Packer will attempt to use the Managed Identity
 and subscription of the VM that Packer is running on.  This will only work if
 Packer is running on an Azure VM with either a System Assigned Managed
-Original file line number
+Diff line change
@@ Expand Up @@
     		OidcRequestURL:   "whatever",
     	}
     	assertInvalid(t, cfg)
     }
     func getEnvOrSkip(t *testing.T, envVar string) string {
@@ Expand Down @@