chore(release): Release version 0.3.5

sorairolake · Aug 4, 2024 · 1eabade · 1eabade
2 parents 00c1a68 + 72bd141
commit 1eabade
Show file tree

Hide file tree

Showing 15 changed files with 74 additions and 51 deletions.
diff --git a/.bumpversion.toml b/.bumpversion.toml
@@ -3,7 +3,7 @@
 # SPDX-License-Identifier: Apache-2.0 OR MIT
 
 [tool.bumpversion]
-current_version = "0.3.4"
+current_version = "0.3.5"
 
 [[tool.bumpversion.files]]
 filename = "cmd/glzip/cli.go"

diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml
@@ -47,7 +47,7 @@ body:
     attributes:
       label: Go version
       description: Output of `go version`.
-      placeholder: 1.22
+      placeholder: "1.22"
     validations:
       required: true
 

diff --git a/.github/workflows/CD.yaml b/.github/workflows/CD.yaml
@@ -5,12 +5,10 @@
 name: CD
 
 on:
-  pull_request:
   push:
-    branches:
-      - "develop"
     tags:
       - "v[0-9]+.[0-9]+.[0-9]+"
+  workflow_dispatch:
 
 permissions:
   contents: write
@@ -37,20 +35,20 @@ jobs:
           gem install asciidoctor
           asciidoctor -V
       - name: Check `.goreleaser.yaml`
-        uses: goreleaser/goreleaser-action@v5.0.0
+        uses: goreleaser/goreleaser-action@v6.0.0
         with:
           distribution: "goreleaser"
           version: "latest"
           args: check
       - name: Check GoReleaser
-        uses: goreleaser/goreleaser-action@v5.0.0
+        uses: goreleaser/goreleaser-action@v6.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
+        uses: goreleaser/goreleaser-action@v6.0.0
         if: startsWith(github.ref, 'refs/tags/')
         with:
           distribution: "goreleaser"

diff --git a/.github/workflows/CI.yaml b/.github/workflows/CI.yaml
@@ -52,7 +52,7 @@ jobs:
         with:
           go-version: "stable"
       - name: Run golangci-lint
-        uses: golangci/golangci-lint-action@v5.1.0
+        uses: golangci/golangci-lint-action@v6.1.0
         with:
           version: "latest"
           args: -E gofmt,goimports -v
diff --git a/.github/workflows/REUSE.yaml b/.github/workflows/REUSE.yaml
@@ -19,4 +19,4 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
       - name: REUSE Compliance Check
-        uses: fsfe/reuse-action@v3.0.0
+        uses: fsfe/reuse-action@v4.0.0
diff --git a/.goreleaser.yaml b/.goreleaser.yaml
@@ -29,7 +29,7 @@ builds:
       - arm64
 
 archives:
-  - format: tar.gz
+  - format: tar.zst
     # use zip for windows archives
     format_overrides:
       - goos: windows
@@ -42,6 +42,9 @@ archives:
       - LICENSES/*
       - README.md
 
+checksum:
+  algorithm: sha3-512
+
 changelog:
   sort: asc
   filters:

diff --git a/CHANGELOG.adoc b/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.4\...v0.3.5[0.3.5] - 2024-08-04
+
+=== Changed
+
+* Update man pages
+
 == {compare-url}/v0.3.3\...v0.3.4[0.3.4] - 2024-05-02
 
 === Changed

diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc
@@ -5,6 +5,10 @@
 = Contribution Guide
 :git-flow-url: https://nvie.com/posts/a-successful-git-branching-model/
 :commit-messages-guide-url: https://github.com/RomuloOliveira/commit-messages-guide
+:conventionalcommits-url: https://www.conventionalcommits.org/en/v1.0.0/
+
+Thank you for your interest in contributing to this project! If you would like
+to contribute to this project, please follow the instructions below if possible.
 
 == Branching model
 
@@ -14,7 +18,8 @@ The branching model of this project is based on the {git-flow-url}[git-flow].
 
 === Commit message
 
-Please see the {commit-messages-guide-url}[Commit messages guide].
+Please see the {commit-messages-guide-url}[Commit messages guide] and the
+{conventionalcommits-url}[Conventional Commits].
 
 == Submitting a pull request
 
@@ -23,7 +28,7 @@ Please see the {commit-messages-guide-url}[Commit messages guide].
 . Create your patch. If your change is a feature or a bugfix, please add a test
   case if possible. Note that the change must pass the CI.
 . Please update the copyright information if possible. This project is
-  compliant with version 3.0 of the
+  compliant with version 3.2 of the
   https://reuse.software/spec/[_REUSE Specification_].
   https://github.com/fsfe/reuse-tool[`reuse`] is useful for updating the
   copyright information.

diff --git a/LICENSE-APACHE → LICENSE b/LICENSE-APACHE → LICENSE
@@ -199,3 +199,27 @@
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
+
+---
+
+MIT License
+
+Copyright (c) 2024 Shun Sakai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/LICENSE-MIT b/LICENSE-MIT
diff --git a/README.md b/README.md
@@ -44,27 +44,28 @@ lzip format compressed files.
 go install github.com/sorairolake/lzip-go/cmd/glzip@latest
 ```
 
-#### 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
 
+To build the command-line utility:
+
 ```sh
-# command-line utility
 just build-cmd
+```
 
-# man page
+To build a man page:
+
+```sh
 just build-man
 ```
 
+The man page is generated in `docs/man/man1`. Note that [Asciidoctor] is
+required when building the man page.
+
 ### Usage
 
 Please see [`glzip(1)`].
@@ -95,7 +96,7 @@ Copyright &copy; 2024 Shun Sakai (see [AUTHORS.adoc])
 This package is distributed under the terms of either the _Apache License 2.0_
 or the _MIT License_.
 
-This project is compliant with version 3.0 of the [_REUSE Specification_]. See
+This project is compliant with version 3.2 of the [_REUSE Specification_]. See
 copyright notices of individual files for more details on copyright and
 licensing information.
 
@@ -107,8 +108,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
+[Asciidoctor]: https://asciidoctor.org/
 [`glzip(1)`]: docs/man/man1/glzip.1.adoc
 [CHANGELOG.adoc]: CHANGELOG.adoc
 [CONTRIBUTING.adoc]: CONTRIBUTING.adoc

diff --git a/cmd/glzip/cli.go b/cmd/glzip/cli.go
@@ -11,7 +11,7 @@ import (
 	"github.com/sorairolake/lzip-go"
 )
 
-const version = "0.3.4"
+const version = "0.3.5"
 
 type options struct {
 	version        bool

diff --git a/cmd/glzip/testdata/version.ct b/cmd/glzip/testdata/version.ct
@@ -3,4 +3,4 @@
 # SPDX-License-Identifier: Apache-2.0 OR MIT
 
 $ glzip -version
-glzip 0.3.4
+glzip 0.3.5
diff --git a/docs/man/man1/glzip.1.adoc b/docs/man/man1/glzip.1.adoc
@@ -4,10 +4,11 @@
 
 = glzip(1)
 // Specify in UTC.
-:docdate: 2024-04-14
+:docdate: 2024-08-01
 :doctype: manpage
-:mansource: glzip 0.3.4
+:mansource: glzip 0.3.5
 :manmanual: General Commands Manual
+:lzip-spec-url: https://www.nongnu.org/lzip/manual/lzip_manual.html#File-format
 
 == NAME
 
@@ -19,8 +20,13 @@ glzip - reduces the size of files
 
 == DESCRIPTION
 
-*{manname}* is a simple command-line utility for reading and writing of lzip
-format compressed files.
+*{manname}* is a simple command-line utility for reading and writing of
+{lzip-spec-url}[lzip format] compressed files.
+
+The lzip format uses a simplified form of the LZMA stream format. In most
+cases, *{manname}* achieves better compression ratios than alternatives such as
+*gzip*(1) and *bzip2*(1). Decompression speed is faster than *bzip2*(1), but
+slower than *gzip*(1).
 
 == POSITIONAL ARGUMENTS
 
@@ -112,4 +118,4 @@ WARRANTY, to the extent permitted by law.
 
 == SEE ALSO
 
-*lzip*(1)
+*bzip2*(1), *gzip*(1), *lzip*(1)
diff --git a/justfile b/justfile
@@ -3,6 +3,7 @@
 # SPDX-License-Identifier: Apache-2.0 OR MIT
 
 alias all := default
+alias build-cmd := build-cmd-debug
 
 # Run default recipe
 default: test