miller/docs6/docs/build.md

Quick links:   Flag list   Verb list   Function list   Glossary   Repository ↗

# Building from source

Please also see Installation for information about pre-built executables.

You will need to first install Go version 1.15 or higher: please see https://go.dev.

Miller license

Two-clause BSD license https://github.com/johnkerl/miller/blob/master/LICENSE.txt.

From release tarball

• Obtain mlr-i.j.k.tar.gz from https://github.com/johnkerl/miller/tags, replacing i.j.k with the desired release, e.g. 6.1.0.
• tar zxvf mlr-i.j.k.tar.gz
• cd mlr-i.j.k
• cd go
• ./build creates the go/mlr executable and runs regression tests
• go build mlr.go creates the go/mlr executable without running regression tests

From git clone

• git clone https://github.com/johnkerl/miller
• cd miller/go
• ./build creates the go/mlr executable and runs regression tests
• go build mlr.go creates the go/mlr executable without running regression tests

In case of problems

If you have any build errors, feel free to open an issue with "New Issue" at https://github.com/johnkerl/miller/issues.

Dependencies

Required external dependencies

These are necessary to produce the mlr executable.

• Go version 1.15 or higher: please see https://go.dev
• Others packaged within go.mod and go.sum which you don't need to deal with manually -- the Go build process handles them for us

Optional external dependencies

This documentation pageset is built using https://www.mkdocs.org/. Please see https://github.com/johnkerl/miller/blob/main/docs6/README.md for details.

Creating a new release: for developers

At present I'm the primary developer so this is just my checklist for making new releases.

In this example I am using version 6.1.0 to 6.2.0; of course that will change for subsequent revisions.

• Update version found in mlr --version and man mlr:

  • Edit go/src/version/version.go from 6.1.0-dev to 6.2.0.
  • cd ../docs6
  • export PATH=../go:$PATH
  • make html
  • The ordering is important: the first build creates mlr; the second runs mlr to create manpage.txt; the third includes manpage.txt into one of its outputs.
  • Commit and push.

• Create the release tarball and SRPM:

  • TBD for the Go port ...
  • Linux/MacOS/Windows binaries from GitHub Actions ...
  • Pull back release tarball mlr-6.2.0.tar.gz from buildbox, and mlr.{arch} binaries from whatever buildboxes.

• Create the Github release tag:

  • Don't forget the v in v6.2.0
  • Write the release notes
  • Attach the release tarball and binaries. Double-check assets were successfully uploaded.
  • Publish the release

• Check the release-specific docs:

  • Look at https://miller.readthedocs.io for new-version docs, after a few minutes' propagation time. Note this won't work until Miller 6 is released.
  • ISP-push to https://johnkerl.org/miller6. (Until release: this is a temporary substitute for readthedocs.)

• Notify:

  • Only do these once Miller 6 is released:
  • Submit brew pull request; notify any other distros which don't appear to have autoupdated since the previous release (notes below)
  • Similarly for macports: https://github.com/macports/macports-ports/blob/master/textproc/miller/Portfile
  • Social-media updates.

# brew notes:
git remote add upstream https://github.com/Homebrew/homebrew-core # one-time setup only
git fetch upstream
git rebase upstream/master
git checkout -b miller-6.1.0
shasum -a 256 /path/to/mlr-6.1.0.tar.gz
edit Formula/miller.rb
# Test the URL from the line like
#   url "https://github.com/johnkerl/miller/releases/download/v6.1.0/mlr-6.1.0.tar.gz"
# in a browser for typos.
# A '@BrewTestBot Test this please' comment within the homebrew-core pull request
# will restart the homebrew travis build.
git add Formula/miller.rb
git commit -m 'miller 6.1.0'
git push -u origin miller-6.1.0
(submit the pull request)

• Afterwork:

  • Edit go/src/version/version.go to change version from 6.2.0 to 6.2.0-dev.
  • cd go
  • ./build
  • Commit and push.

Misc. development notes

I use terminal width 120 and tabwidth 4.