Ensure returns after handling errors; edit docs; make Version Bump Check more resilient (#48)

Author: emmahsax

.github/workflows/version-bump-check.yml

@@ -6,7 +6,7 @@ on:
 env:
   description: version update
   file: main.go
-  regex: packageVersion\s+=\s+"\S+"
+  regex: \s+packageVersion\s+=\s+"\S+"
 
 jobs:
   main:
@@ -21,16 +21,27 @@ jobs:
         name: Check for Changes
         run: |
           changed_file="$(git diff ${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }} ${{ env.file }})"
+
           if [ -z "$changed_file" ]; then
             exit 1
           else
-            added_match=$(echo "$changed_file" | grep -E '^\+\s+${{ env.regex }}')
-            removed_match=$(echo "$changed_file" | grep -E '^\-\s+${{ env.regex }}')
-            if [[ -n "$added_match" ]] && [[ -n "$removed_match" ]]; then
+            added_match=$(echo "$changed_file" | grep -E '^\+${{ env.regex }}' || true)
+            removed_match=$(echo "$changed_file" | grep -E '^\-${{ env.regex }}' || true)
+
+            if [[ -z "$added_match" ]] && [[ -z "$removed_match" ]]; then
+              exit 1
+            fi
+
+            if [[ -n "$added_match" ]]; then
               echo "added_match=$added_match" >> $GITHUB_OUTPUT
+            else
+              echo "added_match=" >> $GITHUB_OUTPUT
+            fi
+
+            if [[ -n "$removed_match" ]]; then
               echo "removed_match=$removed_match" >> $GITHUB_OUTPUT
             else
-              exit 1
+              echo "removed_match=" >> $GITHUB_OUTPUT
             fi
           fi
 

README.md

@@ -22,7 +22,7 @@ sudo mv git-helper_darwin_arm64 /usr/local/bin/git-helper
 
 ### Downloading from GitHub Releases
 
-Alternatively, you can download pre-built binaries straight from [GitHub Releases](https://github.com/emmahsax/go-git-helper/releases). After downloading, move them into `/usr/local/bin` and change the permissions. The examples below assume the binaries downloaded to `~/Downlaods`:
+Alternatively, you can download pre-built binaries straight from [GitHub Releases](https://github.com/emmahsax/go-git-helper/releases). After downloading, move them into `/usr/local/bin` and change the permissions. The examples below assume the binaries downloaded to `~/Downloads`:
 
 ```bash
 sudo mv ~/Downloads/git-helper_darwin_arm64 /usr/local/bin/git-helper
@@ -48,7 +48,7 @@ git-helper update
 
 Your `sudo` password may be required, and you may need to verify the package is runable as following the instructions above.
 
-## Setup
+## Config Setup
 
 Some of the commands can be used without any additional configuration. However, others utilize special GitHub or GitLab configuration. To set up access with GitHub/GitLab, run:
 
@@ -83,6 +83,8 @@ Please run with `help` to see more:
 git-helper --help
 ```
 
+In addition, hopefully all these options below make working with git and Go's Git Helper more seamless.
+
 ### With Plugins
 
 As an additional enhancement, you can set each of the following commands to be a git plugin, meaning you can call them in a way that feels more git-native:
@@ -119,7 +121,23 @@ And then, running `gnb` maps to `git new-branch`, which again routes to `git-hel
 
 For a full list of the git aliases I prefer to use, check out my [Git Aliases gist](https://gist.github.com/emmahsax/e8744fe253fba1f00a621c01a2bf68f5).
 
-Hopefully all these options makes working with git more seamless.
+### With Completion
+
+To set up completion (auto-filling commands as you type), run:
+
+```bash
+mkdir -p ~/.git-helper/completions
+git-helper completion bash >> ~/.git-helper/completions/completion.bash
+git-helper completion fish >> ~/.git-helper/completions/completion.fish
+git-helper completion powershell >> ~/.git-helper/completions/completion.powershell
+git-helper completion zsh >> ~/.git-helper/completions/completion.zsh
+```
+
+Then load the appropriate completion file for your scripting language to this to your shell file (e.g. load the following into your `~/.zshrc`):
+
+```bash
+source ~/.git-helper/completions/completion.zsh
+```
 
 ## Commands
 

cmd/codeRequest/codeRequest.go

@@ -58,6 +58,7 @@ func (cr *CodeRequest) execute() {
 	} else {
 		err := errors.New("could not locate GitHub or GitLab remote URLs")
 		utils.HandleError(err, cr.Debug, nil)
+		return
 	}
 }
 

cmd/update/update.go

@@ -108,18 +108,21 @@ func (u *Update) downloadAndSaveBinary(downloadURL, binaryName string) {
 	resp, err := http.Get(downloadURL)
 	if err != nil {
 		utils.HandleError(err, u.Debug, nil)
+		return
 	}
 	defer resp.Body.Close()
 
 	out, err := os.Create(binaryName)
 	if err != nil {
 		utils.HandleError(err, u.Debug, nil)
+		return
 	}
 	defer out.Close()
 
 	_, err = io.Copy(out, resp.Body)
 	if err != nil {
 		utils.HandleError(err, u.Debug, nil)
+		return
 	}
 }
 

internal/configfile/configfile.go

@@ -98,17 +98,19 @@ func (cf *ConfigFile) GitLabToken() string {
 }
 
 func (cf *ConfigFile) configFileContents() map[string]string {
+	var result map[string]string
 	data, err := os.ReadFile(cf.ConfigFile())
 	if err != nil {
 		customErr := errors.New("error reading file: " + err.Error())
 		utils.HandleError(customErr, cf.Debug, nil)
+		return result
 	}
 
-	var result map[string]string
 	err = yaml.Unmarshal(data, &result)
 	if err != nil {
 		customErr := errors.New("error unmarshaling YAML: " + err.Error())
 		utils.HandleError(customErr, cf.Debug, nil)
+		return result
 	}
 
 	return result

internal/githubPullRequest/githubPullRequest.go

@@ -54,6 +54,7 @@ func (pr *GitHubPullRequest) Create() {
 	if err != nil {
 		customErr := errors.New("could not create pull request: " + err.Error())
 		utils.HandleError(customErr, pr.Debug, nil)
+		return
 	}
 
 	fmt.Println("Pull request successfully created:", *resp.HTMLURL)
@@ -65,6 +66,7 @@ func (pr *GitHubPullRequest) newPrBody() string {
 		content, err := os.ReadFile(templateName)
 		if err != nil {
 			utils.HandleError(err, pr.Debug, nil)
+			return ""
 		}
 
 		return string(content)

internal/gitlabMergeRequest/gitlabMergeRequest.go

@@ -53,6 +53,7 @@ func (mr *GitLabMergeRequest) Create() {
 	if err != nil {
 		customErr := errors.New("could not create merge request: " + err.Error())
 		utils.HandleError(customErr, mr.Debug, nil)
+		return
 	}
 
 	fmt.Println("Merge request successfully created:", resp.WebURL)
@@ -75,6 +76,7 @@ func (mr *GitLabMergeRequest) newMrBody() string {
 		content, err := os.ReadFile(templateName)
 		if err != nil {
 			utils.HandleError(err, mr.Debug, nil)
+			return ""
 		}
 
 		return string(content)

main.go

@@ -21,8 +21,8 @@ import (
 
 var (
 	packageOwner      = "emmahsax"
-	packageVersion    = "0.0.6"
 	packageRepository = "go-git-helper"
+	packageVersion    = "0.0.7"
 )
 
 func main() {
@@ -48,8 +48,8 @@ func newCommand() *cobra.Command {
 	cmd.AddCommand(forgetLocalChanges.NewCommand())
 	cmd.AddCommand(forgetLocalCommits.NewCommand())
 	cmd.AddCommand(newBranch.NewCommand())
-	cmd.AddCommand(setup.NewCommand(packageOwner, packageRepository))
 	cmd.AddCommand(setHeadRef.NewCommand())
+	cmd.AddCommand(setup.NewCommand(packageOwner, packageRepository))
 	cmd.AddCommand(update.NewCommand(packageOwner, packageRepository))
 	cmd.AddCommand(version.NewCommand(packageVersion))