From ed4baf09b05e78a5e1ad7834b5b1576426986285 Mon Sep 17 00:00:00 2001 From: Patrick Cowland Date: Wed, 23 Jul 2025 11:35:04 +0100 Subject: [PATCH] Corrected project name --- .github/ISSUE_TEMPLATE/bug_report.md | 4 ++-- .github/ISSUE_TEMPLATE/question.md | 4 ++-- Makefile | 8 ++++---- cmd/plugin/add.go | 6 +++--- cmd/plugin/list.go | 6 +++--- cmd/plugin/plugin.go | 4 ++-- cmd/plugin/remove.go | 6 +++--- examples/plugin/README.md | 4 ++-- examples/plugin/plugin.go | 2 +- internal/commands/license/license_internal.go | 2 +- internal/output/output.go | 2 +- internal/plugins/plugins.go | 6 +++--- 12 files changed, 27 insertions(+), 27 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index aac395ec..f27ce988 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -17,7 +17,7 @@ labels: type/bug,status/needs-triage ### Description -### PingCLI Version +### Ping CLI Version ### Affected Command(s) @@ -29,7 +29,7 @@ labels: type/bug,status/needs-triage ### Panic Output - + ### Expected Behavior diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index 64c3d6ea..894553c6 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -7,11 +7,11 @@ labels: type/question,status/needs-triage ### Description - + ### Additional Context - + ### References diff --git a/Makefile b/Makefile index 63f7fe32..f6fc9e7a 100644 --- a/Makefile +++ b/Makefile @@ -43,10 +43,10 @@ test: --checktestenvvars --test-cmd --test-internal-commands --test-internal-con --checktestenvvars: @echo -n "Checking for required environment variables to run pingcli tests..." - @test -n "$$TEST_PINGONE_ENVIRONMENT_ID" || { echo " FAILED"; echo "TEST_PINGONE_ENVIRONMENT_ID environment variable is not set.\n\nCreate/Specify an unconfigured PingOne environment to test PingCLI with. The following services are required: PingOne SSO, PingOne MFA, PingOne Protect, PingOne DaVinci, PingOne Authorize, and PingFederate"; exit 1; } - @test -n "$$TEST_PINGONE_REGION_CODE" || { echo " FAILED"; echo "TEST_PINGONE_REGION_CODE environment variable is not set.\n\nCreate/Specify an unconfigured PingOne environment to test PingCLI with. The following services are required: PingOne SSO, PingOne MFA, PingOne Protect, PingOne DaVinci, PingOne Authorize, and PingFederate"; exit 1; } - @test -n "$$TEST_PINGONE_WORKER_CLIENT_ID" || { echo " FAILED"; echo "TEST_PINGONE_WORKER_CLIENT_ID environment variable is not set.\n\nCreate/Specify a worker applicaiton in the unconfigured PingOne environment with all admin roles to test PingCLI with"; exit 1; } - @test -n "$$TEST_PINGONE_WORKER_CLIENT_SECRET" || { echo " FAILED"; echo "TEST_PINGONE_WORKER_CLIENT_SECRET environment variable is not set.\n\nCreate/Specify a worker applicaiton in an unconfigured PingOne environment with all admin roles to test PingCLI with"; exit 1; } + @test -n "$$TEST_PINGONE_ENVIRONMENT_ID" || { echo " FAILED"; echo "TEST_PINGONE_ENVIRONMENT_ID environment variable is not set.\n\nCreate/Specify an unconfigured PingOne environment to test Ping CLI with. The following services are required: PingOne SSO, PingOne MFA, PingOne Protect, PingOne DaVinci, PingOne Authorize, and PingFederate"; exit 1; } + @test -n "$$TEST_PINGONE_REGION_CODE" || { echo " FAILED"; echo "TEST_PINGONE_REGION_CODE environment variable is not set.\n\nCreate/Specify an unconfigured PingOne environment to test Ping CLI with. The following services are required: PingOne SSO, PingOne MFA, PingOne Protect, PingOne DaVinci, PingOne Authorize, and PingFederate"; exit 1; } + @test -n "$$TEST_PINGONE_WORKER_CLIENT_ID" || { echo " FAILED"; echo "TEST_PINGONE_WORKER_CLIENT_ID environment variable is not set.\n\nCreate/Specify a worker applicaiton in the unconfigured PingOne environment with all admin roles to test Ping CLI with"; exit 1; } + @test -n "$$TEST_PINGONE_WORKER_CLIENT_SECRET" || { echo " FAILED"; echo "TEST_PINGONE_WORKER_CLIENT_SECRET environment variable is not set.\n\nCreate/Specify a worker applicaiton in an unconfigured PingOne environment with all admin roles to test Ping CLI with"; exit 1; } @echo " SUCCESS" --test-cmd: diff --git a/cmd/plugin/add.go b/cmd/plugin/add.go index 519b7f0e..c4c74bda 100644 --- a/cmd/plugin/add.go +++ b/cmd/plugin/add.go @@ -10,7 +10,7 @@ import ( ) const ( - addPluginCommandExamples = ` Add a plugin to use with PingCLI. + addPluginCommandExamples = ` Add a plugin to use with Ping CLI. pingcli plugin add pingcli-plugin-executable` ) @@ -19,9 +19,9 @@ func NewPluginAddCommand() *cobra.Command { Args: common.ExactArgs(1), DisableFlagsInUseLine: true, // We write our own flags in @Use attribute Example: addPluginCommandExamples, - Long: `Add a plugin to use with PingCLI.`, + Long: `Add a plugin to use with Ping CLI.`, RunE: pluginAddRunE, - Short: "Add a plugin to use with PingCLI", + Short: "Add a plugin to use with Ping CLI", Use: "add plugin-executable", } diff --git a/cmd/plugin/list.go b/cmd/plugin/list.go index 7f92c712..7618f2a6 100644 --- a/cmd/plugin/list.go +++ b/cmd/plugin/list.go @@ -10,7 +10,7 @@ import ( ) const ( - listPluginCommandExamples = ` List all plugins currently in use with PingCLI. + listPluginCommandExamples = ` List all plugins currently in use with Ping CLI. pingcli plugin list` ) @@ -19,9 +19,9 @@ func NewPluginListCommand() *cobra.Command { Args: common.ExactArgs(0), DisableFlagsInUseLine: true, // We write our own flags in @Use attribute Example: listPluginCommandExamples, - Long: `List all plugins currently in use with PingCLI.`, + Long: `List all plugins currently in use with Ping CLI.`, RunE: pluginListRunE, - Short: "List all plugins currently in use with PingCLI", + Short: "List all plugins currently in use with Ping CLI", Use: "list", } diff --git a/cmd/plugin/plugin.go b/cmd/plugin/plugin.go index e2f647dc..b95f1568 100644 --- a/cmd/plugin/plugin.go +++ b/cmd/plugin/plugin.go @@ -8,8 +8,8 @@ import ( func NewPluginCommand() *cobra.Command { cmd := &cobra.Command{ - Long: `Manage PingCLI plugins.`, - Short: "Manage PingCLI plugins.", + Long: `Manage Ping CLI plugins.`, + Short: "Manage Ping CLI plugins.", Use: "plugin", } diff --git a/cmd/plugin/remove.go b/cmd/plugin/remove.go index f0202687..3e00ca10 100644 --- a/cmd/plugin/remove.go +++ b/cmd/plugin/remove.go @@ -10,7 +10,7 @@ import ( ) const ( - removePluginCommandExamples = ` Remove a plugin from PingCLI. + removePluginCommandExamples = ` Remove a plugin from Ping CLI. pingcli plugin remove pingcli-plugin-executable` ) @@ -19,9 +19,9 @@ func NewPluginRemoveCommand() *cobra.Command { Args: common.ExactArgs(1), DisableFlagsInUseLine: true, // We write our own flags in @Use attribute Example: removePluginCommandExamples, - Long: `Remove a plugin from PingCLI.`, + Long: `Remove a plugin from Ping CLI.`, RunE: pluginRemoveRunE, - Short: "Remove a plugin from PingCLI", + Short: "Remove a plugin from Ping CLI", Use: "remove plugin-executable", } diff --git a/examples/plugin/README.md b/examples/plugin/README.md index 086d7f00..41f5adcd 100644 --- a/examples/plugin/README.md +++ b/examples/plugin/README.md @@ -1,4 +1,4 @@ -# PingCLI Plugin Development Guide +# Ping CLI Plugin Development Guide Welcome to the developer guide for creating `pingcli` plugins! This document provides all the information you need to build, test, and distribute your own custom commands to extend the functionality of the `pingcli` tool. @@ -27,7 +27,7 @@ The `pingcli` plugin system allows developers to create new commands that integr - **Go 1.24+** (for building Go plugins) - [HashiCorp go-plugin](https://github.com/hashicorp/go-plugin) (used by both host and plugin) -- **PingCLI v0.7.0+** installed and configured +- **Ping CLI v0.7.0+** installed and configured ## How Plugins Work diff --git a/examples/plugin/plugin.go b/examples/plugin/plugin.go index 482111d7..c0c177fc 100644 --- a/examples/plugin/plugin.go +++ b/examples/plugin/plugin.go @@ -1,6 +1,6 @@ // Copyright © 2025 Ping Identity Corporation -// Package 'plugin' provides an example implementation of a PingCLI command plugin. +// Package 'plugin' provides an example implementation of a Ping CLI command plugin. // // It demonstrates the required structure and interfaces for building a new // command that can be dynamically loaded and executed by the main pingcli diff --git a/internal/commands/license/license_internal.go b/internal/commands/license/license_internal.go index dcf88c33..d4c72d0c 100644 --- a/internal/commands/license/license_internal.go +++ b/internal/commands/license/license_internal.go @@ -71,7 +71,7 @@ func runLicenseRequest(ctx context.Context, product, version, devopsUser, devops req.Header.Set("Devops-User", devopsUser) req.Header.Set("Devops-Key", devopsKey) - req.Header.Set("Devops-App", "PingCLI") + req.Header.Set("Devops-App", "Ping CLI") req.Header.Set("Devops-Purpose", "download-license") req.Header.Set("Product", product) req.Header.Set("Version", version) diff --git a/internal/output/output.go b/internal/output/output.go index d4b4cc39..c5f4ecca 100644 --- a/internal/output/output.go +++ b/internal/output/output.go @@ -96,7 +96,7 @@ func SystemError(message string, fields map[string]interface{}) { l := logger.Get() systemMsg := fmt.Sprintf(`FATAL: %s -This is a bug in PingCLI and needs reporting to our team. +This is a bug in Ping CLI and needs reporting to our team. Please raise an issue at https://github.com/pingidentity/pingcli`, message) diff --git a/internal/plugins/plugins.go b/internal/plugins/plugins.go index 0cb3ea03..826b0b88 100644 --- a/internal/plugins/plugins.go +++ b/internal/plugins/plugins.go @@ -72,7 +72,7 @@ func createHPluginClient(pluginExecutable string) *hplugin.Client { Level: hclog.Debug, }) - // PingCLI is the host process. Start the plugin process + // Ping CLI is the host process. Start the plugin process client := hplugin.NewClient(&hplugin.ClientConfig{ HandshakeConfig: grpc.HandshakeConfig, Plugins: grpc.PluginMap, @@ -95,7 +95,7 @@ func dispensePlugin(client *hplugin.Client, pluginExecutable string) (grpc.PingC return nil, fmt.Errorf("failed to create Plugin RPC client: %w", err) } - // All PingCLI plugins are expected to serve the ENUM_PINGCLI_COMMAND_GRPC plugin via + // All Ping CLI plugins are expected to serve the ENUM_PINGCLI_COMMAND_GRPC plugin via // the PluginMap within the plugin.Serve() method. // Non-Golang plugins unable to use the shared grpc module should supply the // raw value of ENUM_PINGCLI_COMMAND_GRPC "pingcli_command_grpc" for the PluginMap key. @@ -126,7 +126,7 @@ func pluginConfiguration(pluginExecutable string) (conf *grpc.PingCliCommandConf // The configuration method is defined by the protobuf definition. // The plugin should return relevant cobra command information // even if the plugin does not use cobra commands internally. - // This allows the host process PingCLI to present the plugin command + // This allows the host process Ping CLI to present the plugin command // in the help output. resp, err := plugin.Configuration() if err != nil {