README
¶
goxzst 
This is a command to make cross builds, ZIP archives, SHA digests. As well as it can render templates, for example, Homebrew formula and Kubernetes Krew yaml.
goxzst is an abbreviation of the following letters:
- X (cross builds)
- Z (ZIP archives)
- S (SHA digests)
- T (templates)
Getting Started
Install the latest release.
# go
go get github.com/int128/goxzst
# GitHub Releases
curl -sfL -o /tmp/goxzst.zip https://github.com/int128/goxzst/releases/download/v1.0.1/goxzst_linux_amd64.zip
unzip /tmp/goxzst.zip -d ~/bin
To make .zip and .sha256 files for the default target platforms:
goxzst -o hello
goxzst will make the following files:
dist/hello_darwin_amd64.zip
dist/hello_darwin_amd64.zip.sha256
dist/hello_linux_amd64.zip
dist/hello_linux_amd64.zip.sha256
dist/hello_windows_amd64.zip
dist/hello_windows_amd64.zip.sha256
Each zip file contains the executable file:
% zipinfo dist/hello_linux_amd64.zip
Archive: dist/hello_linux_amd64.zip
Zip file size: 2040916 bytes, number of entries: 1
-rwxr-xr-x 2.0 unx 4100026 bl defN 19-Apr-04 14:44 hello
1 file, 4100026 bytes uncompressed, 2040792 bytes compressed: 50.2%
To make a Homebrew Formula, create homebrew.rb and run:
goxzst -o hello -t homebrew.rb
goxzst will make the following files:
dist/hello_darwin_amd64.zip
dist/hello_darwin_amd64.zip.sha256
dist/hello_linux_amd64.zip
dist/hello_linux_amd64.zip.sha256
dist/hello_windows_amd64.zip
dist/hello_windows_amd64.zip.sha256
dist/homebrew.rb
Usage
You can set the following options:
Usage:
goxzst -o NAME [-d DIR] [-osarch "GOOS_GOARCH ..."] [-i "FILE ..."] [-a ALGORITHM] [-t "FILE ..."] [--] [build args]
Options:
-a string
Digest algorithm. One of (sha256|sha512) (default "sha256")
-d string
Output directory (default "dist")
-i string
List of extra files to add to the zip, separated by space
-o string
Output name (mandatory)
-osarch string
List of GOOS_GOARCH separated by space (default "linux_amd64 darwin_amd64 windows_amd64")
-parallelism int
Number of parallel build. Default to the current CPU cores
-t string
List of template files separated by space
goxzst does the following steps for each platform:
- Build an executable file for the platform.
- Pack the executable file into an archive file.
- Generate the digest of the archive file.
and optionally renders the templates. Finally it removes the executable files.
Cross build
You can set the target platforms by -osarch option:
goxzst -o hello -osarch "linux_amd64 linux_arm"
You can pass extra arguments to go build after double dash:
goxzst -o hello -- -ldflags "-X main.version=$VERSION"
Archive
You can add extra files to the archive file by -i option:
goxzst -o hello -i "LICENSE README.md"
Digest
You can set the digest algorithm by -a option:
goxzst -o hello -a sha512
Template
You can pass template files by -t option:
goxzst -o hello -t homebrew.rb
goxzst will render the template as a Go template and write it to a file which has the same filename (not including directory path) of the template.
You can use the following functions and variables in a template.
| Name | Description | Example |
|---|---|---|
env(string) string |
Value of the environment variable. | env "VERSION" |
sha256(string) string |
SHA-256 digest of the file. | sha256 .linux_amd64_archive |
sha512(string) string |
SHA-512 digest of the file. | sha512 .linux_amd64_archive |
.GOOS_GOARCH_executable |
Path to the executable file. | .linux_amd64_executable |
.GOOS_GOARCH_archive |
Path to the archive file. | .linux_amd64_archive |
.GOOS_GOARCH_digest |
Path to the digest file. | .linux_amd64_digest |
For example, you can render SHA-256 digest of the archive file as follows:
{{ sha256 .linux_amd64_archive }}
See also the examples: homebrew.rb and krew.yaml.
Related works
This is inspired by Songmu/goxz. Thank you for the great work.
You can upload ZIP files to GitHub Releases using int128/ghcp.
Contributions
This is an open source software. Feel free to open issues and pull requests.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
adaptors
|
|
|
cmd
Package cmd provides the command line interface (CLI).
|
Package cmd provides the command line interface (CLI). |
|
env
Package env provides the environment variables access and command execution.
|
Package env provides the environment variables access and command execution. |
|
env/mock_env
Package mock_env is a generated GoMock package.
|
Package mock_env is a generated GoMock package. |
|
fs
Package fs provides the file system access.
|
Package fs provides the file system access. |
|
fs/mock_fs
Package mock_fs is a generated GoMock package.
|
Package mock_fs is a generated GoMock package. |
|
log
Package log provides the logging feature.
|
Package log provides the logging feature. |
|
models
|
|
|
build
Package build contains the models of build.
|
Package build contains the models of build. |
|
digest
Package digest provides the message digest features.
|
Package digest provides the message digest features. |
|
usecases
|
|
|
archive
Package archive provides the use-case to archive an executable file and extra files.
|
Package archive provides the use-case to archive an executable file and extra files. |
|
archive/mock_archive
Package mock_archive is a generated GoMock package.
|
Package mock_archive is a generated GoMock package. |
|
crossbuild
Package crossbuild provides the use-case to build executables for platforms.
|
Package crossbuild provides the use-case to build executables for platforms. |
|
crossbuild/mock_crossbuild
Package mock_crossbuild is a generated GoMock package.
|
Package mock_crossbuild is a generated GoMock package. |
|
digest
Package digest provides the use-case to generate a digest.
|
Package digest provides the use-case to generate a digest. |
|
digest/mock_digest
Package mock_digest is a generated GoMock package.
|
Package mock_digest is a generated GoMock package. |
|
rendertemplate
Package rendertemplate provides the use-case to render a template.
|
Package rendertemplate provides the use-case to render a template. |
|
rendertemplate/mock_rendertemplate
Package mock_rendertemplate is a generated GoMock package.
|
Package mock_rendertemplate is a generated GoMock package. |
|
xzs
Package xzs provides the use-case to make an executable, archive and digest for a platform.
|
Package xzs provides the use-case to make an executable, archive and digest for a platform. |
|
xzs/mock_xzs
Package mock_xzs is a generated GoMock package.
|
Package mock_xzs is a generated GoMock package. |
|
xzst
Package xzst provides the use-case to make the archives, digests and templates (XZST).
|
Package xzst provides the use-case to make the archives, digests and templates (XZST). |
|
xzst/mock_xzst
Package mock_xzst is a generated GoMock package.
|
Package mock_xzst is a generated GoMock package. |