Release abcrypt-cli version 0.2.12

sorairolake · Jan 21, 2024 · 90f9bef · 90f9bef
2 parents 9e6609c + b4e969a
commit 90f9bef
Show file tree

Hide file tree

Showing 17 changed files with 316 additions and 25 deletions.
diff --git a/.github/workflows/CD.yaml b/.github/workflows/CD.yaml
@@ -59,7 +59,7 @@ jobs:
           targets: ${{ matrix.target }}
       - name: Install cross
         if: ${{ matrix.use-cross }}
-        uses: taiki-e/[email protected].2
+        uses: taiki-e/[email protected].7
         with:
           tool: cross
       - name: Cache build artifacts

diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml
@@ -35,6 +35,10 @@ jobs:
         uses: extractions/setup-just@v1
       - name: Build a book
         run: just build-book
+      - name: Minify a book
+        uses: docker://tdewolff/minify:latest
+        with:
+          args: --exclude "build/site/_/**" -o build/ -r build/
       - name: Deploy
         uses: peaceiris/[email protected]
         if: startsWith(github.ref, 'refs/tags/')

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/antora-playbook.yml b/antora-playbook.yml
@@ -20,7 +20,12 @@ ui:
   bundle:
     url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable
     snapshot: true
+  supplemental_files: docs/book/supplemental-ui
 
 runtime:
   log:
     failure_level: warn
+
+antora:
+  extensions:
+    - "@antora/lunr-extension"
diff --git a/crates/abcrypt/Cargo.toml b/crates/abcrypt/Cargo.toml
@@ -21,7 +21,7 @@ include = ["/LICENSES", "/README.md", "/src"]
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-argon2 = { version = "0.5.2", default-features = false }
+argon2 = { version = "0.5.3", default-features = false }
 blake2 = { version = "0.10.6", default-features = false }
 chacha20poly1305 = { version = "0.10.1", default-features = false, features = ["getrandom"] }
 rand = { version = "0.8.5", default-features = false, features = ["getrandom", "std_rng"] }

diff --git a/crates/cli/CHANGELOG.adoc b/crates/cli/CHANGELOG.adoc
@@ -14,6 +14,13 @@ 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}/abcrypt-cli-v0.2.11\...abcrypt-cli-v0.2.12[0.2.12] - 2024-01-21
+
+=== Changed
+
+* Add description about behavior of `-h`, `--help` and `--version` in man pages
+  ({pull-request-url}/234[#234])
+
 == {compare-url}/abcrypt-cli-v0.2.10\...abcrypt-cli-v0.2.11[0.2.11] - 2024-01-18
 
 === Changed

diff --git a/crates/cli/Cargo.toml b/crates/cli/Cargo.toml
@@ -4,7 +4,7 @@
 
 [package]
 name = "abcrypt-cli"
-version = "0.2.11"
+version = "0.2.12"
 authors.workspace = true
 edition.workspace = true
 rust-version.workspace = true
@@ -28,7 +28,7 @@ abcrypt = { version = "0.2.10", path = "../abcrypt", features = ["serde"] }
 anyhow.workspace = true
 byte-unit = "5.1.3"
 clap = { workspace = true, features = ["wrap_help"] }
-clap_complete = "4.4.7"
+clap_complete = "4.4.8"
 clap_complete_nushell = "4.4.2"
 dialoguer.workspace = true
 serde_json = { version = "1.0.111", optional = true }

diff --git a/crates/cli/docs/man/man1/abcrypt-decrypt.1.adoc b/crates/cli/docs/man/man1/abcrypt-decrypt.1.adoc
@@ -4,7 +4,7 @@
 
 = abcrypt-decrypt(1)
 // Specify in UTC.
-:docdate: 2023-09-07
+:docdate: 2024-01-19
 :doctype: manpage
 ifdef::revnumber[:mansource: abcrypt {revnumber}]
 :manmanual: General Commands Manual
@@ -61,11 +61,13 @@ _FILE_::
 
 *-h*, *--help*::
 
-  Print help information.
+  Print help message. The short flag (*-h*) will print a condensed help message
+  while the long flag (*--help*) will print a detailed help message.
 
 *-V*, *--version*::
 
-  Print version information.
+  Print version number. The long flag (*--version*) will also print the
+  copyright notice, the license notice and where to report bugs.
 
 include::{includedir}/section-exit-status.adoc[]
 

diff --git a/crates/cli/docs/man/man1/abcrypt-encrypt.1.adoc b/crates/cli/docs/man/man1/abcrypt-encrypt.1.adoc
@@ -4,7 +4,7 @@
 
 = abcrypt-encrypt(1)
 // Specify in UTC.
-:docdate: 2023-09-07
+:docdate: 2024-01-19
 :doctype: manpage
 ifdef::revnumber[:mansource: abcrypt {revnumber}]
 :manmanual: General Commands Manual
@@ -84,11 +84,13 @@ _FILE_::
 
 *-h*, *--help*::
 
-  Print help information.
+  Print help message. The short flag (*-h*) will print a condensed help message
+  while the long flag (*--help*) will print a detailed help message.
 
 *-V*, *--version*::
 
-  Print version information.
+  Print version number. The long flag (*--version*) will also print the
+  copyright notice, the license notice and where to report bugs.
 
 include::{includedir}/section-exit-status.adoc[]
 

diff --git a/crates/cli/docs/man/man1/abcrypt-information.1.adoc b/crates/cli/docs/man/man1/abcrypt-information.1.adoc
@@ -4,7 +4,7 @@
 
 = abcrypt-information(1)
 // Specify in UTC.
-:docdate: 2023-08-27
+:docdate: 2024-01-19
 :doctype: manpage
 ifdef::revnumber[:mansource: abcrypt {revnumber}]
 :manmanual: General Commands Manual
@@ -41,11 +41,13 @@ endif::[]
 
 *-h*, *--help*::
 
-  Print help information.
+  Print help message. The short flag (*-h*) will print a condensed help message
+  while the long flag (*--help*) will print a detailed help message.
 
 *-V*, *--version*::
 
-  Print version information.
+  Print version number. The long flag (*--version*) will also print the
+  copyright notice, the license notice and where to report bugs.
 
 include::{includedir}/section-exit-status.adoc[]
 

diff --git a/crates/cli/docs/man/man1/abcrypt.1.adoc b/crates/cli/docs/man/man1/abcrypt.1.adoc
@@ -4,7 +4,7 @@
 
 = abcrypt(1)
 // Specify in UTC.
-:docdate: 2023-08-27
+:docdate: 2024-01-19
 :doctype: manpage
 ifdef::revnumber[:mansource: abcrypt {revnumber}]
 :manmanual: General Commands Manual
@@ -45,11 +45,13 @@ abcrypt format.
 
 *-h*, *--help*::
 
-  Print help information.
+  Print help message. The short flag (*-h*) will print a condensed help message
+  while the long flag (*--help*) will print a detailed help message.
 
 *-V*, *--version*::
 
-  Print version information.
+  Print version number. The long flag (*--version*) will also print the
+  copyright notice, the license notice and where to report bugs.
 
 *--generate-completion* _SHELL_::
 

diff --git a/docs/book/supplemental-ui/partials/footer-content.hbs b/docs/book/supplemental-ui/partials/footer-content.hbs
@@ -0,0 +1,4 @@
+<footer class="footer">
+  <p>&copy; 2022&ndash;{{year}} Shun Sakai &middot; <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank">CC BY 4.0</a></p>
+  <p>Powered by <a href="https://antora.org/" target="_blank">Antora</a> &amp; <a href="https://gitlab.com/antora/antora-ui-default" target="_blank">Antora Default UI</a></p>
+</footer>
diff --git a/docs/book/supplemental-ui/partials/footer-content.hbs.license b/docs/book/supplemental-ui/partials/footer-content.hbs.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2024 Shun Sakai
+
+SPDX-License-Identifier: CC-BY-4.0
diff --git a/docs/book/supplemental-ui/partials/header-content.hbs b/docs/book/supplemental-ui/partials/header-content.hbs
@@ -0,0 +1,25 @@
+<header class="header">
+  <nav class="navbar">
+    <div class="navbar-brand">
+      <a class="navbar-item" href="{{{or site.url siteRootPath}}}">{{site.title}}</a>
+      {{#if env.SITE_SEARCH_PROVIDER}}
+      <div class="navbar-item search hide-for-print">
+        <div id="search-field" class="field">
+          <input id="search-input" type="text" placeholder="Search the docs"{{#if page.home}} autofocus{{/if}}>
+        </div>
+      </div>
+      {{/if}}
+      <button class="navbar-burger" aria-controls="topbar-nav" aria-expanded="false" aria-label="Toggle main menu">
+        <span></span>
+        <span></span>
+        <span></span>
+      </button>
+    </div>
+    <div id="topbar-nav" class="navbar-menu">
+      <div class="navbar-end">
+        <a class="navbar-item" href="{{{or site.url siteRootPath}}}">Home</a>
+        <a class="navbar-item" href="https://github.com/sorairolake/abcrypt" target="_blank">Repository</a>
+      </div>
+    </div>
+  </nav>
+</header>
diff --git a/docs/book/supplemental-ui/partials/header-content.hbs.license b/docs/book/supplemental-ui/partials/header-content.hbs.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2024 Shun Sakai
+
+SPDX-License-Identifier: CC-BY-4.0
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		SPDX-FileCopyrightText: 2024 Shun Sakai

		SPDX-License-Identifier: CC-BY-4.0