Release version 0.3.4

.bumpversion.toml

@@ -3,10 +3,13 @@
 # SPDX-License-Identifier: Apache-2.0 OR MIT
 
 [tool.bumpversion]
-current_version = "0.3.3"
+current_version = "0.3.4"
 
 [[tool.bumpversion.files]]
 filename = "cmd/glzip/cli.go"
 
+[[tool.bumpversion.files]]
+filename = "cmd/glzip/testdata/version.ct"
+
 [[tool.bumpversion.files]]
 filename = "docs/man/man1/glzip.1.adoc"

.github/workflows/CD.yaml

@@ -0,0 +1,60 @@
+# SPDX-FileCopyrightText: 2024 Shun Sakai
+#
+# SPDX-License-Identifier: Apache-2.0 OR MIT
+
+name: CD
+
+on:
+  pull_request:
+  push:
+    branches:
+      - "develop"
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+"
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Go environment
+        uses: actions/setup-go@v5
+        with:
+          go-version: "stable"
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2
+      - name: Install Asciidoctor
+        run: |
+          gem install asciidoctor
+          asciidoctor -V
+      - name: Check `.goreleaser.yaml`
+        uses: goreleaser/goreleaser-action@v5.0.0
+        with:
+          distribution: "goreleaser"
+          version: "latest"
+          args: check
+      - name: Check GoReleaser
+        uses: goreleaser/goreleaser-action@v5.0.0
+        if: ${{ !startsWith(github.ref, 'refs/tags/') }}
+        with:
+          distribution: "goreleaser"
+          version: "latest"
+          args: release --clean --snapshot
+      - name: Run GoReleaser
+        uses: goreleaser/goreleaser-action@v5.0.0
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          distribution: "goreleaser"
+          version: "latest"
+          args: release --clean
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/CI.yaml

@@ -21,7 +21,7 @@ jobs:
       matrix:
         os:
           - ubuntu-22.04
-          - macos-12
+          - macos-14
           - windows-2022
         go-version:
           - "1.22" # Go version
@@ -52,7 +52,7 @@ jobs:
         with:
           go-version: "stable"
       - name: Run golangci-lint
-        uses: golangci/golangci-lint-action@v4.0.0
+        uses: golangci/golangci-lint-action@v5.1.0
         with:
           version: "latest"
           args: -E gofmt,goimports -v

.gitignore

@@ -8,6 +8,13 @@
 *.dll
 *.so
 *.dylib
+/glzip
 
 # Test binary, built with `go test -c`
 *.test
+
+# Generated man page
+glzip.1
+
+# GoReleaser
+dist/

.goreleaser.yaml

@@ -0,0 +1,50 @@
+# SPDX-FileCopyrightText: 2024 Shun Sakai
+#
+# SPDX-License-Identifier: Apache-2.0 OR MIT
+
+version: 1
+
+before:
+  hooks:
+    - go mod tidy
+    - asciidoctor -b manpage docs/man/man1/glzip.1.adoc
+
+builds:
+  - main: ./cmd/glzip
+    binary: glzip
+    flags:
+      - -trimpath
+    ldflags:
+      - -s -w
+    env:
+      - CGO_ENABLED=0
+    goos:
+      - darwin
+      - freebsd
+      - linux
+      - openbsd
+      - windows
+    goarch:
+      - amd64
+      - arm64
+
+archives:
+  - format: tar.gz
+    # use zip for windows archives
+    format_overrides:
+      - goos: windows
+        format: zip
+    files:
+      - AUTHORS.adoc
+      - CHANGELOG.adoc
+      - CONTRIBUTING.adoc
+      - docs/man/man1/glzip.1
+      - LICENSES/*
+      - README.md
+
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - "^docs:"
+      - "^test:"

CHANGELOG.adoc

@@ -14,6 +14,12 @@ All notable changes to this project will be documented in this file.
 The format is based on https://keepachangelog.com/[Keep a Changelog], and this
 project adheres to https://semver.org/[Semantic Versioning].
 
+== {compare-url}/v0.3.3\...v0.3.4[0.3.4] - 2024-05-02
+
+=== Changed
+
+* Change to provide pre-built binaries ({pull-request-url}/21[#21])
+
 == {compare-url}/v0.3.2\...v0.3.3[0.3.3] - 2024-04-16
 
 === Changed

README.md

@@ -36,13 +36,26 @@ See the [documentation][reference-url] for more details.
 This package includes a simple command-line utility for reading and writing of
 lzip format compressed files.
 
-To install:
+### Installation
+
+#### From source
 
 ```sh
 go install github.com/sorairolake/lzip-go/cmd/glzip@latest
 ```
 
-To build:
+#### Via a package manager
+
+| OS    | Package manager | Command                              |
+| ----- | --------------- | ------------------------------------ |
+| _Any_ | [Homebrew]      | `brew install sorairolake/tap/glzip` |
+
+#### From binaries
+
+The [release page] contains pre-built binaries for Linux, macOS, Windows and
+others.
+
+#### How to build
 
 ```sh
 # command-line utility
@@ -52,7 +65,9 @@ just build-cmd
 just build-man
 ```
 
-See [`glzip(1)`] for details.
+### Usage
+
+Please see [`glzip(1)`].
 
 ## Minimum Go version
 
@@ -92,6 +107,8 @@ licensing information.
 [lzip compressed format]: https://www.nongnu.org/lzip/manual/lzip_manual.html#File-format
 [Go]: https://go.dev/
 [`example_test.go`]: example_test.go
+[Homebrew]: https://brew.sh/
+[release page]: https://github.com/sorairolake/lzip-go/releases
 [`glzip(1)`]: docs/man/man1/glzip.1.adoc
 [CHANGELOG.adoc]: CHANGELOG.adoc
 [CONTRIBUTING.adoc]: CONTRIBUTING.adoc

cmd/glzip/cli.go

@@ -11,7 +11,7 @@ import (
 	"github.com/sorairolake/lzip-go"
 )
 
-const version = "0.3.3"
+const version = "0.3.4"
 
 type options struct {
 	version        bool

cmd/glzip/main.go

@@ -7,7 +7,6 @@ package main
 import (
 	"flag"
 	"fmt"
-	"log"
 	"os"
 )
 
@@ -34,13 +33,15 @@ func main() {
 	if !opt.decompress {
 		for _, file := range args {
 			if err := compress(file, output, opt); err != nil {
-				log.Fatal(err)
+				fmt.Fprintln(os.Stderr, err)
+				os.Exit(1)
 			}
 		}
 	} else {
 		for _, file := range args {
 			if err := uncompress(file, output, opt); err != nil {
-				log.Fatal(err)
+				fmt.Fprintln(os.Stderr, err)
+				os.Exit(1)
 			}
 		}
 	}

cmd/glzip/main_test.go

@@ -0,0 +1,84 @@
+// SPDX-FileCopyrightText: 2024 Shun Sakai
+//
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+
+package main
+
+import (
+	"io"
+	"os"
+	"os/exec"
+	"path/filepath"
+	"runtime"
+	"testing"
+
+	"github.com/google/go-cmdtest"
+)
+
+var testFiles = []string{
+	"foo.txt",
+	"fox.lz",
+	"fox_bm.lz",
+	"fox_das46.lz",
+	"fox_de20.lz",
+	"fox_s11.lz",
+	"fox_v2.lz",
+}
+
+func copyFile(srcFile, dstFile string) error {
+	src, err := os.Open(srcFile)
+	if err != nil {
+		return err
+	}
+	defer src.Close()
+
+	dst, err := os.Create(dstFile)
+	if err != nil {
+		return err
+	}
+	defer dst.Close()
+
+	_, err = io.Copy(dst, src)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func TestCLI(t *testing.T) {
+	t.Parallel()
+
+	if runtime.GOOS == "windows" {
+		t.SkipNow()
+	}
+
+	wd, err := os.Getwd()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	if err := exec.Command("go", "build").Run(); err != nil {
+		t.Fatal(err)
+	}
+
+	defer os.Remove("glzip")
+
+	ts, err := cmdtest.Read("testdata")
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	ts.Setup = func(rootDir string) error {
+		for _, testFile := range testFiles {
+			err := copyFile(filepath.Join(wd, "testdata", testFile), filepath.Join(rootDir, testFile))
+			if err != nil {
+				return err
+			}
+		}
+
+		return nil
+	}
+	ts.Commands["glzip"] = cmdtest.Program("glzip")
+	ts.Run(t, false)
+}

cmd/glzip/testdata/compress.ct

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2024 Shun Sakai
+#
+# SPDX-License-Identifier: Apache-2.0 OR MIT
+
+$ glzip foo.txt
+$ cat foo.txt --> FAIL
+$ glzip -decompress foo.txt.lz
+$ cat foo.txt
+Hello, world!
+
+$ glzip -keep foo.txt

cmd/glzip/testdata/compress_dictionary_size.ct

@@ -0,0 +1,15 @@
+# SPDX-FileCopyrightText: 2024 Shun Sakai
+#
+# SPDX-License-Identifier: Apache-2.0 OR MIT
+
+$ glzip -dictionary-size 4194304 foo.txt
+$ cat foo.txt --> FAIL
+$ glzip -decompress foo.txt.lz
+$ cat foo.txt
+Hello, world!
+
+$ glzip -dictionary-size 4095 foo.txt --> FAIL
+lzip: dictionary size is too small
+
+$ glzip -dictionary-size 536870913 foo.txt --> FAIL
+lzip: dictionary size is too large

cmd/glzip/testdata/foo.txt

@@ -0,0 +1 @@
+Hello, world!

cmd/glzip/testdata/foo.txt.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2024 Shun Sakai
+
+SPDX-License-Identifier: Apache-2.0 OR MIT

cmd/glzip/testdata/fox.lz

@@ -0,0 +1 @@
+../../../testdata/fox.lz

cmd/glzip/testdata/fox_bcrc.lz

@@ -0,0 +1 @@
+../../../testdata/fox_bcrc.lz

cmd/glzip/testdata/fox_bm.lz

@@ -0,0 +1 @@
+../../../testdata/fox_bm.lz

cmd/glzip/testdata/fox_crc0.lz

@@ -0,0 +1 @@
+../../../testdata/fox_crc0.lz

cmd/glzip/testdata/fox_das46.lz

@@ -0,0 +1 @@
+../../../testdata/fox_das46.lz

cmd/glzip/testdata/fox_de20.lz

@@ -0,0 +1 @@
+../../../testdata/fox_de20.lz

cmd/glzip/testdata/fox_mes81.lz

@@ -0,0 +1 @@
+../../../testdata/fox_mes81.lz

cmd/glzip/testdata/fox_s11.lz

@@ -0,0 +1 @@
+../../../testdata/fox_s11.lz