example

README

Go CLI Github

This repo is an example with basic workflows for a Go CLI tool hosted on Github. It adds basic PR building, dependabot integration, testing, coverage etc.

How to use

First set up the Github repo

1. Create a new empty Github repository.

Then push some code to main:

1. Install gonew and run this command, replacing the last argument with the name of your new module:

   gonew github.com/smlx/go-cli-github github.com/smlx/newproject
   

2. Create the git repo and push to main (which will become the default branch):

   cd newproject
   git init .
   git branch -M main
   git remote add origin git@github.com:smlx/newproject.git
   git add .
   git commit -a
   git push -u origin main
   

Then customize the code for your repository:

1. Check out a new branch to set up the repo git checkout -b setup

2. Update the code for your project:

   • rename deploy/go-cli-github to deploy/$YOUR_COMMAND
   • update deploy/$YOUR_COMMAND/Dockerfile
   • rename cmd/go-cli-github to cmd/$YOUR_COMMAND
   • update module in cmd/$YOUR_COMMAND/*.go, internal/server/serve_test.go
   • update .goreleaser.yml to build cmd/$YOUR_COMMAND
   • update the links at the top of the README
   • update the build, release, and tag-to-release workflows, replacing go-cli-github with $YOUR_COMMAND.

3. Commit and push:

   git commit -a
   git push -u origin setup
   

4. Open a PR, ensure all the actions are green, then merge the PR.

Configure the repository:

1. Go to repository Settings > General:

   • Disable wiki and projects (unless you plan to use them!)
   • Allow only merge commits for Pull Requests
   • Allow auto-merge
   • Automatically delete head branches

2. Go to repository Settings > Code security and analysis, and enable:

   • Dependabot alerts
   • Dependabot security updates
     • Secret scanning
       • Push protection

3. Go to repository Settings > Actions > General:

   • Set Workflow permissions to "Read repository contents and package permissions"

4. Go to repository Settings > Branches and add branch protection to main, and enable:

   • Require a PR before merging
     • Dismiss stale pull request approvals
   • Require status checks to pass before merging
     • Require branches to be up-to-date before merging.
     • Required status checks:
       • CodeQL
       • build
       • buildimage
       • commitlint
       • go-test
       • lint
   • Include administrators

5. That's it.