From 87af7eb0408015300d8d563eb702c396a4fa9638 Mon Sep 17 00:00:00 2001 From: phm07 <22707808+phm07@users.noreply.github.com> Date: Thu, 5 Feb 2026 16:59:06 +0100 Subject: [PATCH 1/2] refactor: use `DisableAutoGenTag` instead of regex --- internal/cli/root.go | 1 + internal/scripts/generate_docs.go | 32 +------------------------------ 2 files changed, 2 insertions(+), 31 deletions(-) diff --git a/internal/cli/root.go b/internal/cli/root.go index ec9b752a3..d28bc2d29 100644 --- a/internal/cli/root.go +++ b/internal/cli/root.go @@ -43,6 +43,7 @@ func NewRootCommand(s state.State) *cobra.Command { SilenceUsage: true, SilenceErrors: true, DisableFlagsInUseLine: true, + DisableAutoGenTag: true, } util.AddGroup(cmd, "resource", "Resources", diff --git a/internal/scripts/generate_docs.go b/internal/scripts/generate_docs.go index c76df6920..8928d33e9 100644 --- a/internal/scripts/generate_docs.go +++ b/internal/scripts/generate_docs.go @@ -4,8 +4,6 @@ import ( "context" "fmt" "os" - "path/filepath" - "regexp" "github.com/spf13/cobra/doc" @@ -42,35 +40,7 @@ func run() error { cmd := cli.NewRootCommand(s) // Generate the docs - if err := doc.GenMarkdownTree(cmd, dir); err != nil { - return fmt.Errorf("error generating docs: %w", err) - } - - files, err := os.ReadDir(dir) - if err != nil { - return fmt.Errorf("error listing doc files: %w", err) - } - - // Remove the 'Auto generated by...' lines at the bottom of files - // This is done because this line contains the current date, which would create a diff when the file is re-generated - generatedOnRegex := regexp.MustCompile(`\n###### Auto generated by spf13/cobra on .*\n`) - for _, f := range files { - if f.IsDir() { - continue - } - path := filepath.Join(dir, f.Name()) - bytes, err := os.ReadFile(path) - if err != nil { - return fmt.Errorf("could not read file at %q: %w", path, err) - } - bytes = generatedOnRegex.ReplaceAll(bytes, nil) - err = os.WriteFile(path, bytes, f.Type()) - if err != nil { - return fmt.Errorf("could not write file at %q: %w", path, err) - } - } - - return nil + return doc.GenMarkdownTree(cmd, dir) } func main() { From 71cb8208285a483e44db0ac7937330df71d5034b Mon Sep 17 00:00:00 2001 From: phm07 <22707808+phm07@users.noreply.github.com> Date: Fri, 6 Feb 2026 10:07:56 +0100 Subject: [PATCH 2/2] generate docs --- docs/reference/manual/hcloud.md | 1 + docs/reference/manual/hcloud_all.md | 1 + docs/reference/manual/hcloud_all_list.md | 1 + docs/reference/manual/hcloud_certificate.md | 1 + docs/reference/manual/hcloud_certificate_add-label.md | 1 + docs/reference/manual/hcloud_certificate_create.md | 1 + docs/reference/manual/hcloud_certificate_delete.md | 1 + docs/reference/manual/hcloud_certificate_describe.md | 1 + docs/reference/manual/hcloud_certificate_list.md | 1 + docs/reference/manual/hcloud_certificate_remove-label.md | 1 + docs/reference/manual/hcloud_certificate_retry.md | 1 + docs/reference/manual/hcloud_certificate_update.md | 1 + docs/reference/manual/hcloud_completion.md | 1 + docs/reference/manual/hcloud_config.md | 1 + docs/reference/manual/hcloud_config_add.md | 1 + docs/reference/manual/hcloud_config_get.md | 1 + docs/reference/manual/hcloud_config_list.md | 1 + docs/reference/manual/hcloud_config_remove.md | 1 + docs/reference/manual/hcloud_config_set.md | 1 + docs/reference/manual/hcloud_config_unset.md | 1 + docs/reference/manual/hcloud_context.md | 1 + docs/reference/manual/hcloud_context_active.md | 1 + docs/reference/manual/hcloud_context_create.md | 1 + docs/reference/manual/hcloud_context_delete.md | 1 + docs/reference/manual/hcloud_context_list.md | 1 + docs/reference/manual/hcloud_context_rename.md | 1 + docs/reference/manual/hcloud_context_unset.md | 1 + docs/reference/manual/hcloud_context_use.md | 1 + docs/reference/manual/hcloud_datacenter.md | 1 + docs/reference/manual/hcloud_datacenter_describe.md | 1 + docs/reference/manual/hcloud_datacenter_list.md | 1 + docs/reference/manual/hcloud_firewall.md | 1 + docs/reference/manual/hcloud_firewall_add-label.md | 1 + docs/reference/manual/hcloud_firewall_add-rule.md | 1 + docs/reference/manual/hcloud_firewall_apply-to-resource.md | 1 + docs/reference/manual/hcloud_firewall_create.md | 1 + docs/reference/manual/hcloud_firewall_delete-rule.md | 1 + docs/reference/manual/hcloud_firewall_delete.md | 1 + docs/reference/manual/hcloud_firewall_describe.md | 1 + docs/reference/manual/hcloud_firewall_list.md | 1 + docs/reference/manual/hcloud_firewall_remove-from-resource.md | 1 + docs/reference/manual/hcloud_firewall_remove-label.md | 1 + docs/reference/manual/hcloud_firewall_replace-rules.md | 1 + docs/reference/manual/hcloud_firewall_update.md | 1 + docs/reference/manual/hcloud_floating-ip.md | 1 + docs/reference/manual/hcloud_floating-ip_add-label.md | 1 + docs/reference/manual/hcloud_floating-ip_assign.md | 1 + docs/reference/manual/hcloud_floating-ip_create.md | 1 + docs/reference/manual/hcloud_floating-ip_delete.md | 1 + docs/reference/manual/hcloud_floating-ip_describe.md | 1 + docs/reference/manual/hcloud_floating-ip_disable-protection.md | 1 + docs/reference/manual/hcloud_floating-ip_enable-protection.md | 1 + docs/reference/manual/hcloud_floating-ip_list.md | 1 + docs/reference/manual/hcloud_floating-ip_remove-label.md | 1 + docs/reference/manual/hcloud_floating-ip_set-rdns.md | 1 + docs/reference/manual/hcloud_floating-ip_unassign.md | 1 + docs/reference/manual/hcloud_floating-ip_update.md | 1 + docs/reference/manual/hcloud_image.md | 1 + docs/reference/manual/hcloud_image_add-label.md | 1 + docs/reference/manual/hcloud_image_delete.md | 1 + docs/reference/manual/hcloud_image_describe.md | 1 + docs/reference/manual/hcloud_image_disable-protection.md | 1 + docs/reference/manual/hcloud_image_enable-protection.md | 1 + docs/reference/manual/hcloud_image_list.md | 1 + docs/reference/manual/hcloud_image_remove-label.md | 1 + docs/reference/manual/hcloud_image_update.md | 1 + docs/reference/manual/hcloud_iso.md | 1 + docs/reference/manual/hcloud_iso_describe.md | 1 + docs/reference/manual/hcloud_iso_list.md | 1 + docs/reference/manual/hcloud_load-balancer-type.md | 1 + docs/reference/manual/hcloud_load-balancer-type_describe.md | 1 + docs/reference/manual/hcloud_load-balancer-type_list.md | 1 + docs/reference/manual/hcloud_load-balancer.md | 1 + docs/reference/manual/hcloud_load-balancer_add-label.md | 1 + docs/reference/manual/hcloud_load-balancer_add-service.md | 1 + docs/reference/manual/hcloud_load-balancer_add-target.md | 1 + docs/reference/manual/hcloud_load-balancer_attach-to-network.md | 1 + docs/reference/manual/hcloud_load-balancer_change-algorithm.md | 1 + docs/reference/manual/hcloud_load-balancer_change-type.md | 1 + docs/reference/manual/hcloud_load-balancer_create.md | 1 + docs/reference/manual/hcloud_load-balancer_delete-service.md | 1 + docs/reference/manual/hcloud_load-balancer_delete.md | 1 + docs/reference/manual/hcloud_load-balancer_describe.md | 1 + .../reference/manual/hcloud_load-balancer_detach-from-network.md | 1 + docs/reference/manual/hcloud_load-balancer_disable-protection.md | 1 + .../manual/hcloud_load-balancer_disable-public-interface.md | 1 + docs/reference/manual/hcloud_load-balancer_enable-protection.md | 1 + .../manual/hcloud_load-balancer_enable-public-interface.md | 1 + docs/reference/manual/hcloud_load-balancer_list.md | 1 + docs/reference/manual/hcloud_load-balancer_metrics.md | 1 + docs/reference/manual/hcloud_load-balancer_remove-label.md | 1 + docs/reference/manual/hcloud_load-balancer_remove-target.md | 1 + docs/reference/manual/hcloud_load-balancer_set-rdns.md | 1 + docs/reference/manual/hcloud_load-balancer_update-service.md | 1 + docs/reference/manual/hcloud_load-balancer_update.md | 1 + docs/reference/manual/hcloud_location.md | 1 + docs/reference/manual/hcloud_location_describe.md | 1 + docs/reference/manual/hcloud_location_list.md | 1 + docs/reference/manual/hcloud_network.md | 1 + docs/reference/manual/hcloud_network_add-label.md | 1 + docs/reference/manual/hcloud_network_add-route.md | 1 + docs/reference/manual/hcloud_network_add-subnet.md | 1 + docs/reference/manual/hcloud_network_change-ip-range.md | 1 + docs/reference/manual/hcloud_network_create.md | 1 + docs/reference/manual/hcloud_network_delete.md | 1 + docs/reference/manual/hcloud_network_describe.md | 1 + docs/reference/manual/hcloud_network_disable-protection.md | 1 + docs/reference/manual/hcloud_network_enable-protection.md | 1 + docs/reference/manual/hcloud_network_expose-routes-to-vswitch.md | 1 + docs/reference/manual/hcloud_network_list.md | 1 + docs/reference/manual/hcloud_network_remove-label.md | 1 + docs/reference/manual/hcloud_network_remove-route.md | 1 + docs/reference/manual/hcloud_network_remove-subnet.md | 1 + docs/reference/manual/hcloud_network_update.md | 1 + docs/reference/manual/hcloud_placement-group.md | 1 + docs/reference/manual/hcloud_placement-group_add-label.md | 1 + docs/reference/manual/hcloud_placement-group_create.md | 1 + docs/reference/manual/hcloud_placement-group_delete.md | 1 + docs/reference/manual/hcloud_placement-group_describe.md | 1 + docs/reference/manual/hcloud_placement-group_list.md | 1 + docs/reference/manual/hcloud_placement-group_remove-label.md | 1 + docs/reference/manual/hcloud_placement-group_update.md | 1 + docs/reference/manual/hcloud_primary-ip.md | 1 + docs/reference/manual/hcloud_primary-ip_add-label.md | 1 + docs/reference/manual/hcloud_primary-ip_assign.md | 1 + docs/reference/manual/hcloud_primary-ip_create.md | 1 + docs/reference/manual/hcloud_primary-ip_delete.md | 1 + docs/reference/manual/hcloud_primary-ip_describe.md | 1 + docs/reference/manual/hcloud_primary-ip_disable-protection.md | 1 + docs/reference/manual/hcloud_primary-ip_enable-protection.md | 1 + docs/reference/manual/hcloud_primary-ip_list.md | 1 + docs/reference/manual/hcloud_primary-ip_remove-label.md | 1 + docs/reference/manual/hcloud_primary-ip_set-rdns.md | 1 + docs/reference/manual/hcloud_primary-ip_unassign.md | 1 + docs/reference/manual/hcloud_primary-ip_update.md | 1 + docs/reference/manual/hcloud_server-type.md | 1 + docs/reference/manual/hcloud_server-type_describe.md | 1 + docs/reference/manual/hcloud_server-type_list.md | 1 + docs/reference/manual/hcloud_server.md | 1 + docs/reference/manual/hcloud_server_add-label.md | 1 + docs/reference/manual/hcloud_server_add-to-placement-group.md | 1 + docs/reference/manual/hcloud_server_attach-iso.md | 1 + docs/reference/manual/hcloud_server_attach-to-network.md | 1 + docs/reference/manual/hcloud_server_change-alias-ips.md | 1 + docs/reference/manual/hcloud_server_change-type.md | 1 + docs/reference/manual/hcloud_server_create-image.md | 1 + docs/reference/manual/hcloud_server_create.md | 1 + docs/reference/manual/hcloud_server_delete.md | 1 + docs/reference/manual/hcloud_server_describe.md | 1 + docs/reference/manual/hcloud_server_detach-from-network.md | 1 + docs/reference/manual/hcloud_server_detach-iso.md | 1 + docs/reference/manual/hcloud_server_disable-backup.md | 1 + docs/reference/manual/hcloud_server_disable-protection.md | 1 + docs/reference/manual/hcloud_server_disable-rescue.md | 1 + docs/reference/manual/hcloud_server_enable-backup.md | 1 + docs/reference/manual/hcloud_server_enable-protection.md | 1 + docs/reference/manual/hcloud_server_enable-rescue.md | 1 + docs/reference/manual/hcloud_server_ip.md | 1 + docs/reference/manual/hcloud_server_list.md | 1 + docs/reference/manual/hcloud_server_metrics.md | 1 + docs/reference/manual/hcloud_server_poweroff.md | 1 + docs/reference/manual/hcloud_server_poweron.md | 1 + docs/reference/manual/hcloud_server_reboot.md | 1 + docs/reference/manual/hcloud_server_rebuild.md | 1 + .../manual/hcloud_server_remove-from-placement-group.md | 1 + docs/reference/manual/hcloud_server_remove-label.md | 1 + docs/reference/manual/hcloud_server_request-console.md | 1 + docs/reference/manual/hcloud_server_reset-password.md | 1 + docs/reference/manual/hcloud_server_reset.md | 1 + docs/reference/manual/hcloud_server_set-rdns.md | 1 + docs/reference/manual/hcloud_server_shutdown.md | 1 + docs/reference/manual/hcloud_server_ssh.md | 1 + docs/reference/manual/hcloud_server_update.md | 1 + docs/reference/manual/hcloud_ssh-key.md | 1 + docs/reference/manual/hcloud_ssh-key_add-label.md | 1 + docs/reference/manual/hcloud_ssh-key_create.md | 1 + docs/reference/manual/hcloud_ssh-key_delete.md | 1 + docs/reference/manual/hcloud_ssh-key_describe.md | 1 + docs/reference/manual/hcloud_ssh-key_list.md | 1 + docs/reference/manual/hcloud_ssh-key_remove-label.md | 1 + docs/reference/manual/hcloud_ssh-key_update.md | 1 + docs/reference/manual/hcloud_storage-box-type.md | 1 + docs/reference/manual/hcloud_storage-box-type_describe.md | 1 + docs/reference/manual/hcloud_storage-box-type_list.md | 1 + docs/reference/manual/hcloud_storage-box.md | 1 + docs/reference/manual/hcloud_storage-box_add-label.md | 1 + docs/reference/manual/hcloud_storage-box_change-type.md | 1 + docs/reference/manual/hcloud_storage-box_create.md | 1 + docs/reference/manual/hcloud_storage-box_delete.md | 1 + docs/reference/manual/hcloud_storage-box_describe.md | 1 + docs/reference/manual/hcloud_storage-box_disable-protection.md | 1 + .../reference/manual/hcloud_storage-box_disable-snapshot-plan.md | 1 + docs/reference/manual/hcloud_storage-box_enable-protection.md | 1 + docs/reference/manual/hcloud_storage-box_enable-snapshot-plan.md | 1 + docs/reference/manual/hcloud_storage-box_folders.md | 1 + docs/reference/manual/hcloud_storage-box_list.md | 1 + docs/reference/manual/hcloud_storage-box_remove-label.md | 1 + docs/reference/manual/hcloud_storage-box_reset-password.md | 1 + docs/reference/manual/hcloud_storage-box_rollback-snapshot.md | 1 + docs/reference/manual/hcloud_storage-box_snapshot.md | 1 + docs/reference/manual/hcloud_storage-box_snapshot_add-label.md | 1 + docs/reference/manual/hcloud_storage-box_snapshot_create.md | 1 + docs/reference/manual/hcloud_storage-box_snapshot_delete.md | 1 + docs/reference/manual/hcloud_storage-box_snapshot_describe.md | 1 + docs/reference/manual/hcloud_storage-box_snapshot_list.md | 1 + .../reference/manual/hcloud_storage-box_snapshot_remove-label.md | 1 + docs/reference/manual/hcloud_storage-box_snapshot_update.md | 1 + docs/reference/manual/hcloud_storage-box_subaccount.md | 1 + .../hcloud_storage-box_subaccount_change-home-directory.md | 1 + docs/reference/manual/hcloud_storage-box_subaccount_create.md | 1 + docs/reference/manual/hcloud_storage-box_subaccount_delete.md | 1 + docs/reference/manual/hcloud_storage-box_subaccount_describe.md | 1 + docs/reference/manual/hcloud_storage-box_subaccount_list.md | 1 + .../manual/hcloud_storage-box_subaccount_reset-password.md | 1 + .../hcloud_storage-box_subaccount_update-access-settings.md | 1 + docs/reference/manual/hcloud_storage-box_subaccount_update.md | 1 + .../manual/hcloud_storage-box_update-access-settings.md | 1 + docs/reference/manual/hcloud_storage-box_update.md | 1 + docs/reference/manual/hcloud_version.md | 1 + docs/reference/manual/hcloud_volume.md | 1 + docs/reference/manual/hcloud_volume_add-label.md | 1 + docs/reference/manual/hcloud_volume_attach.md | 1 + docs/reference/manual/hcloud_volume_create.md | 1 + docs/reference/manual/hcloud_volume_delete.md | 1 + docs/reference/manual/hcloud_volume_describe.md | 1 + docs/reference/manual/hcloud_volume_detach.md | 1 + docs/reference/manual/hcloud_volume_disable-protection.md | 1 + docs/reference/manual/hcloud_volume_enable-protection.md | 1 + docs/reference/manual/hcloud_volume_list.md | 1 + docs/reference/manual/hcloud_volume_remove-label.md | 1 + docs/reference/manual/hcloud_volume_resize.md | 1 + docs/reference/manual/hcloud_volume_update.md | 1 + docs/reference/manual/hcloud_zone.md | 1 + docs/reference/manual/hcloud_zone_add-label.md | 1 + docs/reference/manual/hcloud_zone_add-records.md | 1 + docs/reference/manual/hcloud_zone_change-primary-nameservers.md | 1 + docs/reference/manual/hcloud_zone_change-ttl.md | 1 + docs/reference/manual/hcloud_zone_create.md | 1 + docs/reference/manual/hcloud_zone_delete.md | 1 + docs/reference/manual/hcloud_zone_describe.md | 1 + docs/reference/manual/hcloud_zone_disable-protection.md | 1 + docs/reference/manual/hcloud_zone_enable-protection.md | 1 + docs/reference/manual/hcloud_zone_export-zonefile.md | 1 + docs/reference/manual/hcloud_zone_import-zonefile.md | 1 + docs/reference/manual/hcloud_zone_list.md | 1 + docs/reference/manual/hcloud_zone_remove-label.md | 1 + docs/reference/manual/hcloud_zone_remove-records.md | 1 + docs/reference/manual/hcloud_zone_rrset.md | 1 + docs/reference/manual/hcloud_zone_rrset_add-label.md | 1 + docs/reference/manual/hcloud_zone_rrset_add-records.md | 1 + docs/reference/manual/hcloud_zone_rrset_change-ttl.md | 1 + docs/reference/manual/hcloud_zone_rrset_create.md | 1 + docs/reference/manual/hcloud_zone_rrset_delete.md | 1 + docs/reference/manual/hcloud_zone_rrset_describe.md | 1 + docs/reference/manual/hcloud_zone_rrset_disable-protection.md | 1 + docs/reference/manual/hcloud_zone_rrset_enable-protection.md | 1 + docs/reference/manual/hcloud_zone_rrset_list.md | 1 + docs/reference/manual/hcloud_zone_rrset_remove-label.md | 1 + docs/reference/manual/hcloud_zone_rrset_remove-records.md | 1 + docs/reference/manual/hcloud_zone_rrset_set-records.md | 1 + docs/reference/manual/hcloud_zone_set-records.md | 1 + 261 files changed, 261 insertions(+) diff --git a/docs/reference/manual/hcloud.md b/docs/reference/manual/hcloud.md index 450dcf870..afe311ebd 100644 --- a/docs/reference/manual/hcloud.md +++ b/docs/reference/manual/hcloud.md @@ -47,3 +47,4 @@ A command-line interface for Hetzner Cloud * [hcloud version](hcloud_version.md) - Print version information * [hcloud volume](hcloud_volume.md) - Manage Volumes * [hcloud zone](hcloud_zone.md) - Manage DNS Zones and Zone RRSets (records) + diff --git a/docs/reference/manual/hcloud_all.md b/docs/reference/manual/hcloud_all.md index 787c1a314..db016e180 100644 --- a/docs/reference/manual/hcloud_all.md +++ b/docs/reference/manual/hcloud_all.md @@ -26,3 +26,4 @@ Commands that apply to all resources * [hcloud](hcloud.md) - Hetzner Cloud CLI * [hcloud all list](hcloud_all_list.md) - List all resources in the project + diff --git a/docs/reference/manual/hcloud_all_list.md b/docs/reference/manual/hcloud_all_list.md index 77f26f3d6..a111a6a2e 100644 --- a/docs/reference/manual/hcloud_all_list.md +++ b/docs/reference/manual/hcloud_all_list.md @@ -52,3 +52,4 @@ hcloud all list [options] ### SEE ALSO * [hcloud all](hcloud_all.md) - Commands that apply to all resources + diff --git a/docs/reference/manual/hcloud_certificate.md b/docs/reference/manual/hcloud_certificate.md index 15c6cda50..916f15022 100644 --- a/docs/reference/manual/hcloud_certificate.md +++ b/docs/reference/manual/hcloud_certificate.md @@ -33,3 +33,4 @@ Manage Certificates * [hcloud certificate remove-label](hcloud_certificate_remove-label.md) - Remove a label from a Certificate * [hcloud certificate retry](hcloud_certificate_retry.md) - Retry a managed Certificate's issuance * [hcloud certificate update](hcloud_certificate_update.md) - Update a Certificate + diff --git a/docs/reference/manual/hcloud_certificate_add-label.md b/docs/reference/manual/hcloud_certificate_add-label.md index 84038045d..280790fed 100644 --- a/docs/reference/manual/hcloud_certificate_add-label.md +++ b/docs/reference/manual/hcloud_certificate_add-label.md @@ -30,3 +30,4 @@ hcloud certificate add-label [--overwrite]