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, replacingi.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
make
creates the./mlr
(or.\mlr.exe
on Windows) executable- Without
make
:go build github.com/johnkerl/miller/cmd/mlr
- Without
make check
runs tests- Without
make
:go test github.com/johnkerl/miller/internal/pkg/...
andmlr regtest
- Without
make install
installs themlr
executable and themlr
manpage- Without make:
go install github.com/johnkerl/miller/cmd/mlr
will install to GOPATH/bin/mlr
- Without make:
From git clone
git clone https://github.com/johnkerl/miller
make
/go build github.com/johnkerl/miller/cmd/mlr
as above
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
andgo.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/docs/README.md for details.
Creating a new release: for developers
This is 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
andman mlr
:- Edit
internal/pkpg/version/version.go
from6.1.0-dev
to6.2.0
. - Edit version in
docs/mkdocs.yml
from6.1.0
to6.2.0
. - Run
make dev
in the Miller repo base directory - The ordering in this makefile rule is important: the first build creates
mlr
; the second runsmlr
to createmanpage.txt
; the third includesmanpage.txt
into one of its outputs. - Commit and push.
- Edit
-
Create the release tarball:
make release_tarball
- This creates
miller-6.2.0.tar.gz
which we'll upload to GitHub, the URL of which will be in ourmiller.spec
- Get
mlr.{arch}
binaries from latest successful build from https://github.com/johnkerl/miller/actions, or, build them on buildboxes. - Prepare the source RPM following README-RPM.md.
-
Create the Github release tag:
- Don't forget the
v
inv6.2.0
- Write the release notes
- Attach the release tarball, binaries, and SRPM. Double-check assets were successfully uploaded.
- Publish the release
- Don't forget the
-
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.
-
Notify:
- 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.
- Submit
# 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
internal/pkg/version/version.go
to change version from6.2.0
to6.2.0-dev
. cd go
./build
- Commit and push.
- Edit
Misc. development notes
I use terminal width 120 and tabwidth 4.