Merge pull request #2 from merico-dev/rename-from-openstream-to-stream

Rename from openstream to stream

Author: IronCore864

.github/workflows/master-builder.yaml

@@ -0,0 +1,21 @@
+name: Master Builder
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+
+  test:
+      name: Test
+      runs-on: ubuntu-latest
+      steps:
+        - uses: actions/checkout@v2
+        - name: Set up Go
+          uses: actions/setup-go@v2
+          with:
+            go-version: 1.17
+        - name: Build
+          run: make build
+        - name: Test
+          run: go test -v ./...

.github/workflows/master-builder.yml

@@ -10,14 +10,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-
     - name: Set up Go
       uses: actions/setup-go@v2
       with:
         go-version: 1.17
-
     - name: Build
-      run: go build -v ./...
-
+      run: make build
     - name: Test
       run: go test -v ./...

.github/workflows/pr-builder.yml

@@ -8,7 +8,7 @@
 *.dylib
 
 # build
-/openstream
+/dtm
 
 # Test binary, build with `go test -c`
 *.test

.gitignore

@@ -1,8 +1,8 @@
-# Contributing to OpenStream
+# Contributing to DevStream
 
 Thanks for contributing, and thanks for reading this doc before doing it!
 
-This is a set of guidelines for contributing to OpenStream. These are only guidelines, not rules. So, use your best judgment, and feel free to propose changes to this document.
+This is a set of guidelines for contributing to DevStream. These are only guidelines, not rules. So, use your best judgment, and feel free to propose changes to this document.
 
 ## How Can I Contribute?
 
@@ -14,7 +14,7 @@ If you are only fixing a bug, it’s OK to submit a PR without an issue. In this
 
 ## Maintainer Team at Merico
 
-A group of engineers maintains OpenStream at Merico, led by [@ironcore864](https://github.com/ironcore864).
+A group of engineers maintains DevStream at Merico, led by [@ironcore864](https://github.com/ironcore864).
 
 We aim to reply to issues within 24 hours.
 

CONTRIBUTING.md

@@ -3,4 +3,4 @@ build:
 	go build -buildmode=plugin -trimpath -gcflags="all=-N -l" -o plugins/githubactions_0.0.1.so ./cmd/githubactions/
 	go build -buildmode=plugin -trimpath -gcflags="all=-N -l" -o plugins/argocd_0.0.1.so ./cmd/argocd/
 	go build -buildmode=plugin -trimpath -gcflags="all=-N -l" -o plugins/argocdapp_0.0.1.so ./cmd/argocdapp/
-	go build -trimpath -gcflags="all=-N -l" -o openstream ./cmd/openstream/
+	go build -trimpath -gcflags="all=-N -l" -o dtm ./cmd/devstream/

Makefile

@@ -1,7 +1,21 @@
-# DevStream
+<div align="center">
+<br/>
+<img src="https://user-images.githubusercontent.com/3789273/128085813-92845abd-7c26-4fa2-9f98-928ce2246616.png" width="120px">
+
+<br/>
+
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat&logo=github&color=2370ff&labelColor=454545)](http://makeapullrequest.com)
+[![Discord](https://img.shields.io/discord/844603288082186240.svg?style=flat?label=&logo=discord&logoColor=ffffff&color=747df7&labelColor=454545)](https://discord.gg/83rDG6ydVZ)
+![Test](https://github.com/merico-dev/stream/actions/workflows/master-builder.yaml/badge.svg)
+[![Go Report Card](https://goreportcard.com/badge/github.com/merico-dev/stream)](https://goreportcard.com/report/github.com/merico-dev/stream)
 
+# DevStream
+</div>
 Open-source DevOps tool manager (DTM).
 
+<br/>
+
+
 ## Build
 
 ```bash
@@ -11,5 +25,5 @@ make
 ## Run
 
 ```bash
-./openstream install -f examples/config.yaml
+./dtm install -f examples/config.yaml
 ```

README.md

@@ -4,28 +4,34 @@ import (
 	"fmt"
 	"log"
 
-	"github.com/ironcore864/openstream/internal/pkg/argocd"
+	"github.com/merico-dev/stream/internal/pkg/argocd"
 )
 
+// NAME is the name of this DevStream plugin.
 const NAME = "argocd"
 
+// Plugin is the type used by DevStream core. It's a string.
 type Plugin string
 
+// Install implements the installation of ArgoCD.
 func (p Plugin) Install(options *map[string]interface{}) {
 	argocd.Install(options)
 	log.Println("argocd install finished")
 }
 
+// Reinstall implements the reinstallation of ArgoCD.
 func (p Plugin) Reinstall(options *map[string]interface{}) {
 	log.Println("mock: argocd reinstall finished")
 }
 
+// Uninstall implements the uninstallation of ArgoCD.
 func (p Plugin) Uninstall(options *map[string]interface{}) {
 	log.Println("mock: argocd uninstall finished")
 }
 
-var OpenStreamPlugin Plugin
+// DevStreamPlugin is the exported variable used by the DevStream core.
+var DevStreamPlugin Plugin
 
 func main() {
-	fmt.Println("This is a plugin for OpenStream. Use it with OpenStream.")
+	fmt.Println("This is a plugin for DevStream. Use it with DevStream.")
 }

cmd/argocd/main.go

@@ -4,28 +4,34 @@ import (
 	"fmt"
 	"log"
 
-	"github.com/ironcore864/openstream/internal/pkg/argocdapp"
+	"github.com/merico-dev/stream/internal/pkg/argocdapp"
 )
 
+// NAME is the name of this DevStream plugin.
 const NAME = "argocdapps"
 
+// Plugin is the type used by DevStream core. It's a string.
 type Plugin string
 
+// Install implements the installation of an ArgoCD app.
 func (p Plugin) Install(options *map[string]interface{}) {
 	argocdapp.Install(options)
 	log.Println("argocdapps install finished")
 }
 
+// Reinstall implements the installation of an ArgoCD app.
 func (p Plugin) Reinstall(options *map[string]interface{}) {
 	log.Println("mock: argocdapps reinstall finished")
 }
 
+// Uninstall Uninstall the installation of an ArgoCD app.
 func (p Plugin) Uninstall(options *map[string]interface{}) {
 	log.Println("mock: argocdapps uninstall finished")
 }
 
-var OpenStreamPlugin Plugin
+// DevStreamPlugin is the exported variable used by the DevStream core.
+var DevStreamPlugin Plugin
 
 func main() {
-	fmt.Println("This is a plugin for OpenStream. Use it with OpenStream.")
+	fmt.Println("This is a plugin for DevStream. Use it with DevStream.")
 }

cmd/argocdapp/main.go

@@ -3,8 +3,8 @@ package main
 import (
 	"log"
 
-	"github.com/ironcore864/openstream/internal/pkg/config"
-	"github.com/ironcore864/openstream/internal/pkg/plugin"
+	"github.com/merico-dev/stream/internal/pkg/config"
+	"github.com/merico-dev/stream/internal/pkg/plugin"
 	"github.com/spf13/cobra"
 )
 

cmd/openstream/install.go renamed to cmd/devstream/install.go

@@ -8,12 +8,13 @@ var (
 	configFile string
 
 	rootCMD = &cobra.Command{
-		Use:   "openstream",
-		Short: "openstream is an open source DevOps tool manager",
-		Long:  `openstream is an open source DevOps tool manager`,
+		Use:   "dtm",
+		Short: "DevStream is an open-source DevOps tool manager",
+		Long:  `DevStream is an open-source DevOps tool manager`,
 	}
 )
 
+// Execute runs the rootCMD's Execute func.
 func Execute() error {
 	return rootCMD.Execute()
 }

cmd/openstream/main.go renamed to cmd/devstream/main.go

@@ -5,13 +5,13 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/ironcore864/openstream/internal/pkg/version"
+	"github.com/merico-dev/stream/internal/pkg/version"
 )
 
 var versionCMD = &cobra.Command{
 	Use:   "version",
-	Short: "Print the version number of openstream",
-	Long:  `All software has versions. This is openstream's`,
+	Short: "Print the version number of DevStream",
+	Long:  `All software has versions. This is DevStream's`,
 	Run:   versionCMDFunc,
 }
 

cmd/openstream/version.go renamed to cmd/devstream/version.go

@@ -4,28 +4,34 @@ import (
 	"fmt"
 	"log"
 
-	"github.com/ironcore864/openstream/internal/pkg/githubactions"
+	"github.com/merico-dev/stream/internal/pkg/githubactions"
 )
 
+// NAME is the name of this DevStream plugin.
 const NAME = "githubactions"
 
+// Plugin is the type used by DevStream core. It's a string.
 type Plugin string
 
+// Install implements the installation of some GitHub Actions workflows.
 func (p Plugin) Install(options *map[string]interface{}) {
 	githubactions.Install(options)
 	log.Println("github actions install finished")
 }
 
+// Reinstall implements the installation of some GitHub Actions workflows.
 func (p Plugin) Reinstall(options *map[string]interface{}) {
 	log.Println("mock: github actions reinstall finished")
 }
 
+// Uninstall implements the installation of some GitHub Actions workflows.
 func (p Plugin) Uninstall(options *map[string]interface{}) {
 	log.Println("mock: github actions uninstall finished")
 }
 
-var OpenStreamPlugin Plugin
+// DevStreamPlugin is the exported variable used by the DevStream core.
+var DevStreamPlugin Plugin
 
 func main() {
-	fmt.Println("This is a plugin for OpenStream. Use it with OpenStream.")
+	fmt.Println("This is a plugin for DevStream. Use it with DevStream.")
 }

cmd/githubactions/main.go

@@ -1,4 +1,4 @@
-module github.com/ironcore864/openstream
+module github.com/merico-dev/stream
 
 go 1.17
 

go.mod

@@ -6,6 +6,7 @@ import (
 	"github.com/mitchellh/mapstructure"
 )
 
+// Install installs ArgoCD with provided options.
 func Install(options *map[string]interface{}) {
 	var param Param
 	err := mapstructure.Decode(*options, &param)

internal/pkg/argocd/install.go

@@ -1,15 +1,18 @@
 package argocd
 
+// Param is the struct for parameters used by the argocd package.
 type Param struct {
 	Repo  Repo
 	Chart Chart
 }
 
+// Repo is the struct containing details of a git repository.
 type Repo struct {
 	Name string
 	URL  string
 }
 
+// Chart is the struct containing details of a helm chart.
 type Chart struct {
 	Name            string
 	ReleaseName     string `mapstructure:"release_name"`

internal/pkg/argocd/params.go

@@ -6,6 +6,7 @@ import (
 	"github.com/mitchellh/mapstructure"
 )
 
+// Install creates an ArgoCD app yaml and apply it.
 func Install(options *map[string]interface{}) {
 	var param Param
 	err := mapstructure.Decode(*options, &param)

internal/pkg/argocdapp/install.go

@@ -1,21 +1,25 @@
 package argocdapp
 
+// Param is the struct for parameters used by the argocdapp package.
 type Param struct {
 	App         App
 	Destination Destination
 	Source      Source
 }
 
+// App is the struct for an ArgoCD app.
 type App struct {
 	Name      string
 	Namespace string
 }
 
+// Destination is the struct for the destination of an ArgoCD app.
 type Destination struct {
 	Server    string
 	Namespace string
 }
 
+// Source is the struct for the source of an ArgoCD app.
 type Source struct {
 	Valuefile string
 	Path      string

internal/pkg/argocdapp/params.go

@@ -7,16 +7,19 @@ import (
 	"gopkg.in/yaml.v3"
 )
 
+// Config is the struct for loading DevStream configuration YAML files.
 type Config struct {
 	Tools []Tool `yaml:"tools"`
 }
 
+// Tool is the struct for one section of the DevStream configuration file.
 type Tool struct {
 	Name    string                 `yaml:"name"`
 	Version string                 `yaml:"version"`
 	Options map[string]interface{} `yaml:"options"`
 }
 
+// LoadConf reads an input file as a Config struct.
 func LoadConf(fname string) *Config {
 	f, err := ioutil.ReadFile(fname)
 	if err != nil {