chore: add deprecation (#71)

.goreleaser.yaml

@@ -42,3 +42,5 @@ brews:
     commit_author:
       name: rachfop
       email: [email protected]
+    custom_block: |
+      deprecate! date: "2024-05-08", because: "has been replaced by humctl score deploy. For more information visit https://developer.humanitec.com/platform-orchestrator/reference/cli-references/#score-integration."

README.md

@@ -2,6 +2,12 @@
 
 # ![Score](docs/images/logo.svg) Score overview
 
+---
+
+:warning: __The [`humctl` Humanitec CLI](https://developer.humanitec.com/platform-orchestrator/cli/) now supports Score natively and `score-humanitec` is deprecated. Checkout the docs on [how to deploy with humctl](https://developer.humanitec.com/platform-orchestrator/reference/cli-references/#score-integration).__ :warning:
+
+---
+
 Score aims to improve developer productivity and experience by reducing the risk of configuration inconsistencies between local and remote environments. It provides developer-centric workload specification (`score.yaml`) which captures a workloads runtime requirements in a platform-agnostic manner. Learn more [here](https://github.com/score-spec/spec#-what-is-score).
 
 The `score.yaml` specification file can be executed against a _Score Implementation CLI_, a conversion tool for application developers to generate environment specific configuration. In combination with environment specific parameters, the CLI tool can run your workload in the target environment by generating a platform-specific configuration file. The `score-humanitec` CLI is used to generate and deploy a [Humanitec deployment delta](https://developer.humanitec.com/score/reference/delta/).
@@ -29,8 +35,8 @@ If you're just getting started, follow [this guide](https://docs.score.dev/docs/
 
 - Give the project a star!
 - Contact us via email:
-  - [email protected]
-  - [email protected]
+  - <[email protected]>
+  - <[email protected]>
 - See our [documentation](https://docs.score.dev)
 
 ## ![Contributing](docs/images/contributing.svg) Contributing

internal/command/consts.go

@@ -14,6 +14,10 @@ const (
 	apiUrlDefault         = "https://api.humanitec.io"
 	uiUrlDefault          = "https://app.humanitec.io"
 	messageDefault        = "Auto-deployment (SCORE)"
+	deprecationMessage    = `score-humanitec is deprecated, please use the humctl instead.
+For more information visit https://developer.humanitec.com/platform-orchestrator/reference/cli-references/#score-integration.
+
+`
 )
 
 var (

internal/command/delta.go

@@ -56,7 +56,7 @@ func init() {
 var deltaCmd = &cobra.Command{
 	Use:   "delta",
 	Short: "Creates or updates a Humanitec deployment delta from the source SCORE file",
-	Long: `This command will translate the SCORE file into a Humanitec deployment delta and submit it to the Humanitec
+	Long: deprecationMessage + `This command will translate the SCORE file into a Humanitec deployment delta and submit it to the Humanitec
 environment specified by the --org, --app, and --env flags. If the --delta flag is provided, the generated delta will
 be merged with the specified existing delta. The --deploy flag allows the deployment of the delta to be triggered.
 `,

internal/command/draft.go

@@ -39,6 +39,7 @@ func init() {
 var draftCmd = &cobra.Command{
 	Use:   "draft",
 	Short: "DEPRECATED - use 'delta' instead - creates Humanitec deployment draft from the source SCORE file",
+	Long:  deprecationMessage + "DEPRECATED - use 'delta' instead - creates Humanitec deployment draft from the source SCORE file",
 	RunE:  draft,
 }
 

internal/command/root.go

@@ -19,10 +19,15 @@ var (
 	rootCmd = &cobra.Command{
 		Use:   "score-humanitec",
 		Short: "SCORE to Humanitec translator",
-		Long: `SCORE is a specification for defining environment agnostic configuration for cloud based workloads.
+		Long: deprecationMessage + `SCORE is a specification for defining environment agnostic configuration for cloud based workloads.
 This tool creates a Humanitec deployment from the SCORE specification.
 Complete documentation is available at https://score.dev`,
 		Version: fmt.Sprintf("%s (build: %s; sha: %s)", version.Version, version.BuildTime, version.GitSHA),
+		PersistentPreRun: func(cmd *cobra.Command, args []string) {
+			// Setting the deprecation message here as setting it on the cmd
+			// will remove it from the help.
+			fmt.Fprint(cmd.ErrOrStderr(), deprecationMessage)
+		},
 	}
 )
 

internal/command/run.go

@@ -52,6 +52,7 @@ func init() {
 var runCmd = &cobra.Command{
 	Use:   "run",
 	Short: "Translate the SCORE file to Humanitec deployment delta",
+	Long:  deprecationMessage + "Translate the SCORE file to Humanitec deployment delta",
 	RunE:  run,
 }