Merge pull request #74 from daniel-hutao/dev-1

fix: some tips with githubactions for golang

Author: daniel-hutao

cmd/devstream/main.go

@@ -11,8 +11,8 @@ var (
 
 	rootCMD = &cobra.Command{
 		Use:   "dtm",
-		Short: "DevStream is an open-source DevOps tool manager",
-		Long:  `DevStream is an open-source DevOps tool manager`,
+		Short: "DevStream is an open-source DevOps toolchain manager",
+		Long:  `DevStream is an open-source DevOps toolchain manager`,
 	}
 )
 

internal/pkg/githubactions/githubactions.go

@@ -70,7 +70,6 @@ func (ga *GithubActions) AddWorkflow(workflow *Workflow) error {
 		opts)
 
 	if err != nil {
-		log.Println(err)
 		return err
 	}
 	log.Printf("github actions Workflow %s created\n", workflow.workflowFileName)
@@ -104,7 +103,6 @@ func (ga *GithubActions) DeleteWorkflow(workflow *Workflow) error {
 		opts)
 
 	if err != nil {
-		log.Println(err)
 		return err
 	}
 	log.Printf("github actions Workflow %s removed\n", workflow.workflowFileName)
@@ -120,14 +118,14 @@ func (ga *GithubActions) fileExists(filename string) (bool, error) {
 		&github.RepositoryContentGetOptions{},
 	)
 
-	if resp.StatusCode == http.StatusNotFound {
-		return false, nil
-	}
-
 	if err != nil {
 		return false, err
 	}
 
+	if resp.StatusCode == http.StatusNotFound {
+		return false, nil
+	}
+
 	if resp.StatusCode == http.StatusOK {
 		return true, nil
 	}
@@ -141,7 +139,7 @@ func generateGitHubWorkflowFileByName(f string) string {
 func getGitHubToken() string {
 	err := viper.BindEnv("github_token")
 	if err != nil {
-		log.Println("ENV var GITHUB_TOKEN is needed")
+		log.Printf("bind ENV var GITHUB_TOKEN failed: %s", err)
 		return ""
 	}
 
@@ -151,7 +149,7 @@ func getGitHubToken() string {
 func getGitHubClient(ctx context.Context) (*github.Client, error) {
 	token := getGitHubToken()
 	if token == "" {
-		return nil, fmt.Errorf("failed to initialize GitHub token")
+		return nil, fmt.Errorf("failed to initialize GitHub token. More info - https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token")
 	}
 	ts := oauth2.StaticTokenSource(
 		&oauth2.Token{AccessToken: token},

internal/pkg/githubactions/golang/templates.go

@@ -4,7 +4,7 @@ var PrBuilder = `
 name: PR Builder
 on:
   pull_request:
-    branches: [ master ]
+    branches: [ master, main ]
 jobs:
   test:
     runs-on: ubuntu-latest
@@ -14,17 +14,17 @@ jobs:
       uses: actions/setup-go@v2
       with:
         go-version: 1.17
-    - name: Test
-      run: go test -v ./...
     - name: Build
       run: go build -v ./...
+    - name: Test
+      run: go test -v ./...
 `
 
 var MasterBuilder = `
 name: Master Builder
 on:
   push:
-    branches: [ master ]
+    branches: [ master, main ]
 jobs:
   test:
     name: Test

internal/pkg/githubactions/install.go

@@ -1,6 +1,6 @@
 package githubactions
 
-import "fmt"
+import "log"
 
 // Install sets up GitHub Actions workflows.
 func Install(options *map[string]interface{}) (bool, error) {
@@ -10,11 +10,9 @@ func Install(options *map[string]interface{}) (bool, error) {
 	}
 
 	language := githubActions.GetLanguage()
+	log.Printf("language is %s", language.String())
 	ws := defaultWorkflows.GetWorkflowByNameVersionTypeString(language.String())
 
-	fmt.Println("lang is ", language.Name, language.Version, language.String())
-	fmt.Println("ws is ", ws)
-
 	for _, pipeline := range ws {
 		err := githubActions.AddWorkflow(pipeline)
 		if err != nil {

internal/pkg/githubactions/reinstall.go

@@ -1,5 +1,9 @@
 package githubactions
 
+import (
+	"log"
+)
+
 // Reinstall remove and set up GitHub Actions workflows.
 func Reinstall(options *map[string]interface{}) (bool, error) {
 	githubActions, err := NewGithubActions(options)
@@ -8,6 +12,7 @@ func Reinstall(options *map[string]interface{}) (bool, error) {
 	}
 
 	language := githubActions.GetLanguage()
+	log.Printf("language is %s", language.String())
 	ws := defaultWorkflows.GetWorkflowByNameVersionTypeString(language.String())
 
 	for _, pipeline := range ws {

internal/pkg/githubactions/uninstall.go

@@ -1,5 +1,7 @@
 package githubactions
 
+import "log"
+
 // Uninstall remove GitHub Actions workflows.
 func Uninstall(options *map[string]interface{}) (bool, error) {
 	githubActions, err := NewGithubActions(options)
@@ -8,6 +10,7 @@ func Uninstall(options *map[string]interface{}) (bool, error) {
 	}
 
 	language := githubActions.GetLanguage()
+	log.Printf("language is %s", language.String())
 	ws := defaultWorkflows.GetWorkflowByNameVersionTypeString(language.String())
 
 	for _, pipeline := range ws {