docs: add openim scripts deployment system

Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com>

pkg/common/cmd/msg_gateway.go

@@ -15,10 +15,11 @@
 package cmd
 
 import (
-	"github.com/openimsdk/open-im-server/v3/internal/msggateway"
-	config2 "github.com/openimsdk/open-im-server/v3/pkg/common/config"
+	"log"
+
+	"github.com/openimsdk/open-im-server/v3/internal/msggateway"
+	v3config "github.com/openimsdk/open-im-server/v3/pkg/common/config"
 
-	//"github.com/openimsdk/open-im-server/internal/msggateway".
 	"github.com/spf13/cobra"
 
 	"github.com/OpenIMSDK/protocol/constant"
@@ -39,7 +40,10 @@ func (m *MsgGatewayCmd) AddWsPortFlag() {
 }
 
 func (m *MsgGatewayCmd) getWsPortFlag(cmd *cobra.Command) int {
-	port, _ := cmd.Flags().GetInt(constant.FlagWsPort)
+	port, err := cmd.Flags().GetInt(constant.FlagWsPort)
+	if err != nil {
+		log.Println("Error getting ws port flag:", err)
+	}
 	if port == 0 {
 		port = m.PortFromConfig(constant.FlagWsPort)
 	}
@@ -58,9 +62,9 @@ func (m *MsgGatewayCmd) Exec() error {
 }
 func (m *MsgGatewayCmd) GetPortFromConfig(portType string) int {
 	if portType == constant.FlagWsPort {
-		return config2.Config.LongConnSvr.OpenImWsPort[0]
+		return v3config.Config.LongConnSvr.OpenImWsPort[0]
 	} else if portType == constant.FlagPort {
-		return config2.Config.LongConnSvr.OpenImMessageGatewayPort[0]
+		return v3config.Config.LongConnSvr.OpenImMessageGatewayPort[0]
 	} else if portType == constant.FlagPrometheusPort {
 		return 0
 	} else {

pkg/common/cmd/root.go

@@ -97,9 +97,9 @@ func (rc *RootCmd) applyOptions(opts ...func(*CmdOpts)) *CmdOpts {
 
 func (rc *RootCmd) initializeLogger(cmdOpts *CmdOpts) error {
 	logConfig := config.Config.Log
-	
+
 	return log.InitFromConfig(
-		
+
 		cmdOpts.loggerPrefixName,
 		rc.Name,
 		logConfig.RemainLogLevel,
@@ -130,7 +130,10 @@ func (r *RootCmd) AddPortFlag() {
 }
 
 func (r *RootCmd) getPortFlag(cmd *cobra.Command) int {
-	port, _ := cmd.Flags().GetInt(constant.FlagPort)
+	port, err := cmd.Flags().GetInt(constant.FlagPort)
+	if err != nil {
+		fmt.Println("Error getting ws port flag:", err)
+	}
 	if port == 0 {
 		port = r.PortFromConfig(constant.FlagPort)
 	}

pkg/common/version/base.go

@@ -0,0 +1,47 @@
+package version
+
+// Base version information.
+//
+// This is the fallback data used when version information from git is not
+// provided via go ldflags. It provides an approximation of the Kubernetes
+// version for ad-hoc builds (e.g. `go build`) that cannot get the version
+// information from git.
+//
+// If you are looking at these fields in the git tree, they look
+// strange. They are modified on the fly by the build process. The
+// in-tree values are dummy values used for "git archive", which also
+// works for GitHub tar downloads.
+//
+// When releasing a new Kubernetes version, this file is updated by
+// build/mark_new_version.sh to reflect the new version, and then a
+// git annotated tag (using format vX.Y where X == Major version and Y
+// == Minor version) is created to point to the commit that updates
+var (
+	// TODO: Deprecate gitMajor and gitMinor, use only gitVersion
+	// instead. First step in deprecation, keep the fields but make
+	// them irrelevant. (Next we'll take it out, which may muck with
+	// scripts consuming the kubectl version output - but most of
+	// these should be looking at gitVersion already anyways.)
+	gitMajor string = "" // major version, always numeric
+	gitMinor string = "" // minor version, numeric possibly followed by "+"
+
+	// semantic version, derived by build scripts (see
+	// https://github.com/kubernetes/sig-release/blob/master/release-engineering/versioning.md#kubernetes-release-versioning
+	// https://kubernetes.io/releases/version-skew-policy/
+	// for a detailed discussion of this field)
+	//
+	// TODO: This field is still called "gitVersion" for legacy
+	// reasons. For prerelease versions, the build metadata on the
+	// semantic version is a git hash, but the version itself is no
+	// longer the direct output of "git describe", but a slight
+	// translation to be semver compliant.
+
+	// NOTE: The $Format strings are replaced during 'git archive' thanks to the
+	// companion .gitattributes file containing 'export-subst' in this same
+	// directory.  See also https://git-scm.com/docs/gitattributes
+	gitVersion   string = "latest"
+	gitCommit    string = ""            // sha1 from git, output of $(git rev-parse HEAD)
+	gitTreeState string = ""            // state of git tree, either "clean" or "dirty"
+
+	buildDate string = "1970-01-01T00:00:00Z" // build date in ISO8601 format, output of $(date -u +'%Y-%m-%dT%H:%M:%SZ')
+)

pkg/common/version/types.go

@@ -0,0 +1,29 @@
+package version
+
+// Info contains versioning information.
+// TODO: Add []string of api versions supported? It's still unclear
+// how we'll want to distribute that information.
+type Info struct {
+	Major      string `json:"major,omitempty"`
+	Minor      string `json:"minor,omitempty"`
+	GitVersion string `json:"gitVersion"`
+	GitCommit  string `json:"gitCommit,omitempty"`
+	BuildDate  string `json:"buildDate"`
+	GoVersion  string `json:"goVersion"`
+	Compiler   string `json:"compiler"`
+	Platform   string `json:"platform"`
+}
+
+type Output struct {
+	OpenIMServerVersion Info                 `json:"OpenIMServerVersion,omitempty" yaml:"OpenIMServerVersion,omitempty"`
+	OpenIMClientVersion *OpenIMClientVersion `json:"OpenIMClientVersion,omitempty" yaml:"OpenIMClientVersion,omitempty"`
+}
+
+type OpenIMClientVersion struct {
+	ClientVersion string `json:"clientVersion,omitempty" yaml:"clientVersion,omitempty"`	//sdk core version
+}
+
+// String returns info as a human-friendly version string.
+func (info Info) String() string {
+	return info.GitVersion
+}

pkg/common/version/version.go

@@ -0,0 +1,57 @@
+package version
+
+import (
+	"fmt"
+	"runtime"
+
+	"gopkg.in/src-d/go-git.v4"
+)
+
+// Get returns the overall codebase version. It's for detecting
+// what code a binary was built from.
+func Get() Info {
+	// These variables typically come from -ldflags settings and in
+	// their absence fallback to the settings in ./base.go
+	return Info{
+		Major:      gitMajor,
+		Minor:      gitMinor,
+		GitVersion: gitVersion,
+		GitCommit:  gitCommit,
+		BuildDate:  buildDate,
+		GoVersion:  runtime.Version(),
+		Compiler:   runtime.Compiler,
+		Platform:   fmt.Sprintf("%s/%s", runtime.GOOS, runtime.GOARCH),
+	}
+}
+
+// GetClientVersion returns the git version of the OpenIM client repository
+func GetClientVersion() (*OpenIMClientVersion, error) {
+	clientVersion, err := getClientVersion()
+	if err != nil {
+		return nil, err
+	}
+	return &OpenIMClientVersion{
+		ClientVersion: clientVersion,
+	}, nil
+}
+
+func getClientVersion() (string, error) {
+	repo, err := git.PlainClone("/tmp/openim-sdk-core", false, &git.CloneOptions{
+		URL: "https://github.com/OpenIMSDK/openim-sdk-core",
+	})
+	if err != nil {
+		return "", fmt.Errorf("error cloning repository: %w", err)
+	}
+
+	ref, err := repo.Head()
+	if err != nil {
+		return "", fmt.Errorf("error getting head reference: %w", err)
+	}
+
+	return ref.Hash().String(), nil
+}
+
+// GetSingleVersion returns single version of sealer
+func GetSingleVersion() string {
+	return gitVersion
+}