Merge pull request #189 from puppetlabs/private-plans

reidmv · web-flow · commit 23818128bdf1 · 2021-07-21T15:26:54.000-07:00
Highlight user-facing plans by hiding internal plans from bolt plan show output
diff --git a/plans/misc/divert_code_manager.pp b/plans/misc/divert_code_manager.pp
@@ -1,3 +1,6 @@
+# @api private
+# @private true
+#
 # @summary This plan exists to account for a scenario where a PE XL
 # architecture is in use, but code manager is not.
 #
diff --git a/plans/modify_cert_extensions.pp b/plans/modify_cert_extensions.pp
@@ -1,4 +1,5 @@
 # @api private
+# @private true
 plan peadm::modify_cert_extensions (
   TargetSpec              $targets,
   Peadm::SingleTargetSpec $primary_host,
diff --git a/plans/subplans/configure.pp b/plans/subplans/configure.pp
@@ -1,3 +1,6 @@
+# @api private
+# @private true
+#
 # @summary Configure first-time classification and DR setup
 #
 # @param compiler_pool_address 
diff --git a/plans/subplans/install.pp b/plans/subplans/install.pp
@@ -1,4 +1,5 @@
 # @api private
+# @private true
 #
 # @summary Perform initial installation of Puppet Enterprise Extra Large
 #
diff --git a/plans/subplans/modify_certificate.pp b/plans/subplans/modify_certificate.pp
@@ -1,4 +1,5 @@
 # @api private
+# @private true
 plan peadm::subplans::modify_certificate (
   Peadm::SingleTargetSpec $targets,
   TargetSpec              $primary_host,
diff --git a/plans/util/insert_csr_extension_requests.pp b/plans/util/insert_csr_extension_requests.pp
@@ -1,3 +1,5 @@
+# @api private
+# @private true
 plan peadm::util::insert_csr_extension_requests (
   TargetSpec $targets,
   Hash       $extension_requests,
diff --git a/plans/util/retrieve_and_upload.pp b/plans/util/retrieve_and_upload.pp
@@ -1,3 +1,5 @@
+# @api private
+# @private true
 plan peadm::util::retrieve_and_upload(
   TargetSpec $nodes,
   String[1]  $source,
diff --git a/plans/util/sanitize_pg_pe_conf.pp b/plans/util/sanitize_pg_pe_conf.pp
@@ -1,3 +1,5 @@
+# @api private
+# @private true
 plan peadm::util::sanitize_pg_pe_conf (
   TargetSpec              $targets,
   Peadm::SingleTargetSpec $primary_host,

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,6 @@`
	`1`	`+# @api private`
	`2`	`+# @private true`
	`3`	`+#`
`1`	`4`	`# @summary This plan exists to account for a scenario where a PE XL`
`2`	`5`	`# architecture is in use, but code manager is not.`
`3`	`6`	`#`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`# @api private`
	`2`	`+# @private true`
`2`	`3`	`plan peadm::modify_cert_extensions (`
`3`	`4`	`TargetSpec $targets,`
`4`	`5`	`Peadm::SingleTargetSpec $primary_host,`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# @api private`
	`2`	`+# @private true`
`1`	`3`	`plan peadm::util::insert_csr_extension_requests (`
`2`	`4`	`TargetSpec $targets,`
`3`	`5`	`Hash $extension_requests,`