Skip to content

DEVELOPER_GUIDE.md

Latest commit

 

History

History
98 lines (77 loc) · 2.88 KB

DEVELOPER_GUIDE.md

File metadata and controls

98 lines (77 loc) · 2.88 KB

Developer Guide

How To Build

The Stacked Diff Workflow CLI (also known as, the sd command) is written in golang.

  1. Install golang.
  2. Install make. This is already installed on Mac. Instructions for windows are here.
  3. Install lint. Install instructions

Then run:

make build

Binaries are created in ./bin.

Installation From Source

Clone the repository, then build, and then follow the install instructions for your platform.

Code Organization

The main entry point to the Stacked Diff Workflow CLI ("sd") is [main.go]. The commands are implemented under [commands].

How to Debug Unit Tests

make test will run the unit tests. To skip lint use make test -o lint. Check out the TEST_ARGS example in Makefile to run only some test.

If one of the command*_test fails you can use testutil.InitTest(t, slog.LevelDebug) for more detailed logging. This will cause testParseArguments to add a "--log-level=debug to the command line arguments.

You can use TEST_ARGS to run only one test from the command line, see [Makefile].

Making a Release

Follow the steps in golang docs Publishing a module:

# 1. Make addition to [CHANGELOG.md], including Contributors section.
# 2. Update the stable version so that it is equal to current version [util/stable_version.txt]
# 3. Update README.md so it matches latest commands and options.
# Then...
make build
# See that the [README.md] is updated with stable version.
# merge changes, `sd rebase-main`, and then:
git checkout main
go mod tidy
make test
# Make sure all changes merged into main, git status and sd log should
# be empty. Otherwise save your changes, "git reset --hard origin/main",
# create tag, then restore your changes
git status && sd log
export RELEASE_VERSION=`cat util/stable_version.txt`
git tag v$RELEASE_VERSION
git push origin v$RELEASE_VERSION
# Update [util/current_version.txt]

For bubbles and bubbletea forks:

# Make labels in their repositories
git checkout main
git status && sd log
export RELEASE_VERSION=1.3.6
git tag v$RELEASE_VERSION
git push origin v$RELEASE_VERSION
# sd rebase-main if required
GOPROXY=proxy.golang.org go list -m \
  github.com/slackhq/bubbletea@v$RELEASE_VERSION
# In gh-stacked-diff:
# Update version in go.mod replace, then:
# Remove go.work and go.work.sum if using them:
mv go.work ../gh-stacked-diff-go.work
mv go.work.sum ../gh-stacked-diff-go.work.sum
go mod tidy

# Same steps for:
GOPROXY=proxy.golang.org go list -m \
  github.com/slackhq/bubbles@v$RELEASE_VERSION

Once a tag is created [.github/workflows/release.yml] kicks off and creates the binaries for the release.