go-cobra-cli

go-cobra-cli

[[TOC]]

Overview

go-cobra-cli is a full, working implementation of a go cli application; the following project is a template that can be forked, copied for private or personal usage.

The remaining README.md's contents is for non-template usage. Of course, replace section(s) where appropriate -- namely go-cobra-cli and VCS references.

Getting Started

Installing

brew tap iac-factory/homebrew-taps

# --> GitLab Private Configuration Example
# brew tap ethr/homebrew-go-cobra-cli-tap [email protected]:ethrgg/templates/homebrew-go-cobra-cli-tap

# brew install iac-factory/taps/go-cobra-cli --verbose --debug

# --> Simplified
brew install go-cobra-cli

Upgrading

brew update && brew upgrade go-cobra-cli

Reinstalling

brew update
brew unlink go-cobra-cli
brew install go-cobra-cli

Pre-Commit

1. Install pre-commit from https://pre-commit.com/#install

2. Create a .pre-commit-config.yaml file at the root of the repository with the following content:

   repos:
     - repo: https://github.com/gitleaks/gitleaks
       rev: latest
       hooks:
         - id: gitleaks
   

3. Auto-update the config to the latest repos' versions by executing pre-commit autoupdate

4. Install with pre-commit install

Deployment & Initial Setup (Maintainers)

The following section is intended only for project maintainers & developers.

• Please see the getting started section for installation and upgrade instructions.

1. Install goreleaser if it isn't installed

   brew install goreleaser/tap/goreleaser
   

2. Initialize the repository for new repositories

   goreleaser init
   

3. Test the snapshot without VCS deployment

   goreleaser release --snapshot --clean
   

4. Configure the default system's local gitlab_token or github_token secret

   mkdir -p ~/.config/goreleaser && touch ~/.config/goreleaser/gitlab_token
   mkdir -p ~/.config/goreleaser && touch ~/.config/goreleaser/github_token
   

5. Commit and push to VCS

   git add . && git commit -m "CI - Example" && git push
   

6. List git tags to get a version that isn't already established

   git tag --list
   

7. Using the output from above, increment the version and push a new tag

   git tag -a v0.0.1 -m "Bump: Initial Release" && git push origin v0.0.1
   

8. Create and push a new release

   goreleaser release --clean
   

9. Update local Formula to include the new tag (only applicable for private projects)

   sed -i -e "s/using: GitDownloadStrategy/using: GitDownloadStrategy, tag: \"$(git tag --points-at HEAD)\"/g" ./dist/homebrew/Formula/go-cobra-cli.rb
   

10. Copy the updated Formula to system clipboard (only applicable for private projects)

    cat ./dist/homebrew/Formula/go-cobra-cli.rb | pbcopy
    

11. Update the Homebrew Tap's *.rb file with clipboard's contents (only applicable for private projects)

12. Tap the repository using git+ssh protocol (only applicable for private repositories)

    brew tap iac-factory/homebrew-taps [email protected]:iac-factory/homebrew-taps
    

13. Update the Cask if already established

    brew update
    

14. Install the package (see the installation section)

Reference(s)

• go Linking
• goreleaser
  • goreleaser Environment Variable(s)
• Cobra User Guide
• Brew Formula Cookbook
• New Cask Formula

Useful Command(s)

Tags

# --> Delete Remote Tag
git push origin --delete v0.0.0

# --> HEAD Tag
git tag --points-at HEAD

SSH Agent

eval "$(ssh-agent -s)"