feat(version, licenses): Add version and licenses commands (#28)

* feat(version): Add version command

* Version variables are injected by goreleaser on release

Signed-off-by: Manuel Dewald <manuel@codesphere.com>

* Add licenses command and update licenses

Signed-off-by: Manuel Dewald <manuel@codesphere.com>

* update docs

Signed-off-by: Manuel Dewald <manuel@codesphere.com>

* ref(docs): Ensure consistent ordering of docs

Signed-off-by: Manuel Dewald <manuel@codesphere.com>

* devx(gh-action): Add GitHub action to update licenses and docs

Signed-off-by: Manuel Dewald <manuel@codesphere.com>

* add description to version command

Signed-off-by: Manuel Dewald <manuel@codesphere.com>

---------

Signed-off-by: Manuel Dewald <manuel@codesphere.com>

Author: NautiluX

.github/workflows/tag-release.yml

@@ -6,11 +6,28 @@ on:
       - main
 
 jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-tags: true
+          fetch-depth: 0
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.24'
+
+      - name: Update docs & licenses
+        run: hack/update-docs.sh
+
   tag:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
         with:
+          ref: ${{ github.ref }}
           fetch-tags: true
           fetch-depth: 0
 

.goreleaser.yaml

@@ -18,7 +18,13 @@ builds:
     - amd64
     - arm64
     - arm
-    main: ./cmd/cs
+    main: ./cli
+    binary: cs
+    ldflags:
+    - -s -w
+    - -X github.com/codesphere-cloud/cs-go/pkg/cs.version={{.Version}}
+    - -X github.com/codesphere-cloud/cs-go/pkg/cs.commit={{.Commit}}
+    - -X github.com/codesphere-cloud/cs-go/pkg/cs.date={{.Date}}
 
 changelog:
   sort: asc

.mockery.yml

@@ -14,7 +14,7 @@ require-template-schema-exists: true
 template: testify
 template-schema: '{{.Template}}.schema.json'
 packages:
-  github.com/codesphere-cloud/cs-go/cmd:
+  github.com/codesphere-cloud/cs-go/cli/cmd:
     interfaces:
       Client:
       Env:

LICENSE

@@ -188,7 +188,7 @@ file or class name and description of purpose be included on the
 same "printed page" as the copyright notice for easier
 identification within third-party archives.
 
-Copyright [yyyy] [name of copyright owner]
+Copyright 2025 Codesphere Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

Makefile

@@ -46,7 +46,9 @@ endif
 		${OPENAPI_DIR}/test
 	make generate
 
-
+release-binaries:
+	goreleaser release --verbose --skip=validate --skip=publish --clean
+ 
 generate-api: generate-client format
 
 .PHONY: docs
@@ -56,7 +58,7 @@ docs:
 	go run -ldflags="-X 'github.com/codesphere-cloud/cs-go/pkg/out.binName=cs'" hack/gendocs/main.go 
 	cp docs/{cs,README}.md
 
-generate-license:
+generate-license: generate
 	go-licenses report --template .NOTICE.template  ./... > NOTICE
 	copywrite headers apply
 

NOTICE

@@ -3,6 +3,18 @@ Copyright (c) Codesphere Inc.
 
 This project includes code licensed under the following terms:
 
+----------
+Module: github.com/codesphere-cloud/cs-go/pkg/tmpl
+Version: Unknown
+License: Apache-2.0
+License URL: https://github.com/codesphere-cloud/cs-go/blob/HEAD/pkg/tmpl/LICENSE
+ 
+----------
+Module: github.com/cpuguy83/go-md2man/v2/md2man
+Version: v2.0.6
+License: MIT
+License URL: https://github.com/cpuguy83/go-md2man/blob/v2.0.6/LICENSE.md
+ 
 ----------
 Module: github.com/davecgh/go-spew/spew
 Version: v1.1.1
@@ -33,6 +45,12 @@ Version: v0.4.7
 License: MIT
 License URL: https://github.com/rivo/uniseg/blob/v0.4.7/LICENSE.txt
 
+----------
+Module: github.com/russross/blackfriday/v2
+Version: v2.1.0
+License: BSD-2-Clause
+License URL: https://github.com/russross/blackfriday/blob/v2.1.0/LICENSE.txt
+ 
 ----------
 Module: github.com/spf13/cobra
 Version: v1.9.1

cli/cmd/licenses.go

@@ -0,0 +1,41 @@
+/*
+Copyright © 2025 NAME HERE <EMAIL ADDRESS>
+*/
+package cmd
+
+import (
+	_ "embed"
+	"fmt"
+
+	"github.com/codesphere-cloud/cs-go/pkg/tmpl"
+	"github.com/spf13/cobra"
+)
+
+// LicensesCmd represents the licenses command
+type LicensesCmd struct {
+	cmd *cobra.Command
+}
+
+func (c *LicensesCmd) RunE(_ *cobra.Command, args []string) error {
+	fmt.Println("Codesphere CLI License:")
+	fmt.Println(tmpl.License())
+
+	fmt.Println("=================================")
+
+	fmt.Println("Codesphere CLI licenses included work:")
+	fmt.Println(tmpl.Notice())
+
+	return nil
+}
+
+func AddLicensesCmd(rootCmd *cobra.Command) {
+	licenses := LicensesCmd{
+		cmd: &cobra.Command{
+			Use:   "licenses",
+			Short: "Print license information",
+			Long:  `Print information about the Codesphere CLI license and open source licenses of dependencies.`,
+		},
+	}
+	rootCmd.AddCommand(licenses.cmd)
+	licenses.cmd.RunE = licenses.RunE
+}

cli/cmd/list-teams.go

@@ -24,8 +24,8 @@ func addListTeamsCmd(p *cobra.Command, opts GlobalOptions) {
 			Use:   "teams",
 			Short: "list teams",
 			Long:  `list teams available in Codesphere`,
-			Example: out.FormatExampleCommands("list teams", map[string]string{
-				"": "List all teams",
+			Example: out.FormatExampleCommands("list teams", []out.Example{
+				{Desc: "List all teams"},
 			}),
 		},
 		opts: opts,

cli/cmd/list-workspaces.go

@@ -24,8 +24,8 @@ func addListWorkspacesCmd(p *cobra.Command, opts GlobalOptions) {
 			Use:   "workspaces",
 			Short: "list workspaces",
 			Long:  `list workspaces available in Codesphere`,
-			Example: out.FormatExampleCommands("list workspaces", map[string]string{
-				"--team-id <team-id>": "List all workspaces",
+			Example: out.FormatExampleCommands("list workspaces", []out.Example{
+				{Cmd: "--team-id <team-id>", Desc: "List all workspaces"},
 			}),
 		},
 		Opts: opts,

cli/cmd/list.go

@@ -12,14 +12,14 @@ type ListCmd struct {
 	cmd *cobra.Command
 }
 
-func addListCmd(rootCmd *cobra.Command, opts GlobalOptions) {
+func AddListCmd(rootCmd *cobra.Command, opts GlobalOptions) {
 	l := ListCmd{
 		cmd: &cobra.Command{
 			Use:   "list",
 			Short: "list resources",
 			Long:  `list resources available in Codesphere`,
-			Example: out.FormatExampleCommands("list", map[string]string{
-				"workspaces": "List all workspaces",
+			Example: out.FormatExampleCommands("list", []out.Example{
+				{Cmd: "workspaces", Desc: "List all workspaces"},
 			}),
 		},
 	}