From 9a32d5caa0cede3d91b1e1884b0b010d131fe6dd Mon Sep 17 00:00:00 2001 From: Shun Sakai Date: Sat, 20 Jan 2024 05:29:06 +0900 Subject: [PATCH 1/6] Update man pages Add description about behavior of `-h`, `--help` and `--version`. --- crates/cli/CHANGELOG.adoc | 7 +++++++ crates/cli/docs/man/man1/abcrypt-decrypt.1.adoc | 8 +++++--- crates/cli/docs/man/man1/abcrypt-encrypt.1.adoc | 8 +++++--- crates/cli/docs/man/man1/abcrypt-information.1.adoc | 8 +++++--- crates/cli/docs/man/man1/abcrypt.1.adoc | 8 +++++--- 5 files changed, 27 insertions(+), 12 deletions(-) diff --git a/crates/cli/CHANGELOG.adoc b/crates/cli/CHANGELOG.adoc index 2480f921..7cc9bf80 100644 --- 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\...HEAD[Unreleased] + +=== 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/docs/man/man1/abcrypt-decrypt.1.adoc b/crates/cli/docs/man/man1/abcrypt-decrypt.1.adoc index 3be2d3eb..ebd7fce3 100644 --- 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 index bd9aba91..6c810dd5 100644 --- 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 index 50079ec9..63f7a262 100644 --- 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 index f1819c37..30408a35 100644 --- 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_:: From 3398fff6ab5a9fd3c80857e57827fa3b890e3e64 Mon Sep 17 00:00:00 2001 From: Shun Sakai Date: Sun, 21 Jan 2024 00:45:09 +0900 Subject: [PATCH 2/6] Update book Change header and footer. --- antora-playbook.yml | 1 + .../partials/footer-content.hbs | 4 +++ .../partials/footer-content.hbs.license | 3 +++ .../partials/header-content.hbs | 25 +++++++++++++++++++ .../partials/header-content.hbs.license | 3 +++ 5 files changed, 36 insertions(+) create mode 100644 docs/book/supplemental-ui/partials/footer-content.hbs create mode 100644 docs/book/supplemental-ui/partials/footer-content.hbs.license create mode 100644 docs/book/supplemental-ui/partials/header-content.hbs create mode 100644 docs/book/supplemental-ui/partials/header-content.hbs.license diff --git a/antora-playbook.yml b/antora-playbook.yml index 5a14a860..93afa0ae 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -20,6 +20,7 @@ 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: diff --git a/docs/book/supplemental-ui/partials/footer-content.hbs b/docs/book/supplemental-ui/partials/footer-content.hbs new file mode 100644 index 00000000..22253d43 --- /dev/null +++ b/docs/book/supplemental-ui/partials/footer-content.hbs @@ -0,0 +1,4 @@ + diff --git a/docs/book/supplemental-ui/partials/footer-content.hbs.license b/docs/book/supplemental-ui/partials/footer-content.hbs.license new file mode 100644 index 00000000..d52fdfed --- /dev/null +++ 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 new file mode 100644 index 00000000..903ca2b7 --- /dev/null +++ b/docs/book/supplemental-ui/partials/header-content.hbs @@ -0,0 +1,25 @@ +
+ +
diff --git a/docs/book/supplemental-ui/partials/header-content.hbs.license b/docs/book/supplemental-ui/partials/header-content.hbs.license new file mode 100644 index 00000000..d52fdfed --- /dev/null +++ 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 From e0243c302213a43ca1c2edef4ee4183894cec1eb Mon Sep 17 00:00:00 2001 From: Shun Sakai Date: Sun, 21 Jan 2024 02:17:31 +0900 Subject: [PATCH 3/6] Add search engine --- antora-playbook.yml | 4 + package-lock.json | 231 ++++++++++++++++++++++++++++++++++++++++++++ package.json | 1 + 3 files changed, 236 insertions(+) diff --git a/antora-playbook.yml b/antora-playbook.yml index 93afa0ae..41dbbb92 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -25,3 +25,7 @@ ui: runtime: log: failure_level: warn + +antora: + extensions: + - "@antora/lunr-extension" diff --git a/package-lock.json b/package-lock.json index 64292084..f38dcd82 100644 --- a/package-lock.json +++ b/package-lock.json @@ -10,6 +10,7 @@ "license": "CC-BY-4.0", "devDependencies": { "@antora/cli": "^3.1.7", + "@antora/lunr-extension": "^1.0.0-alpha.8", "@antora/site-generator": "^3.1.7", "@djencks/asciidoctor-mathjax": "^0.0.9" } @@ -139,6 +140,21 @@ "node": ">=16.0.0" } }, + "node_modules/@antora/lunr-extension": { + "version": "1.0.0-alpha.8", + "resolved": "https://registry.npmjs.org/@antora/lunr-extension/-/lunr-extension-1.0.0-alpha.8.tgz", + "integrity": "sha512-vdBgW3rsvbnmA236kT2Dckh9n0Db5za2/WxiLnFLgZ05ZO1KJQa9+R2WHaIFuGE7bKKbY+lqfM/i3KiezbL9YQ==", + "dev": true, + "dependencies": { + "cheerio": "1.0.0-rc.10", + "html-entities": "~2.3", + "lunr": "~2.3", + "lunr-languages": "~1.9" + }, + "engines": { + "node": ">=16.0.0" + } + }, "node_modules/@antora/navigation-builder": { "version": "3.1.7", "resolved": "https://registry.npmjs.org/@antora/navigation-builder/-/navigation-builder-3.1.7.tgz", @@ -408,6 +424,12 @@ } ] }, + "node_modules/boolbase": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/boolbase/-/boolbase-1.0.0.tgz", + "integrity": "sha512-JZOSA7Mo9sNGB8+UjSgzdLtokWAky1zbztM3WRLCbZ70/3cTANmQmOdR7y2g+J0e2WXywy1yS468tY+IruqEww==", + "dev": true + }, "node_modules/brace-expansion": { "version": "1.1.11", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", @@ -501,6 +523,43 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/cheerio": { + "version": "1.0.0-rc.10", + "resolved": "https://registry.npmjs.org/cheerio/-/cheerio-1.0.0-rc.10.tgz", + "integrity": "sha512-g0J0q/O6mW8z5zxQ3A8E8J1hUgp4SMOvEoW/x84OwyHKe/Zccz83PVT4y5Crcr530FV6NgmKI1qvGTKVl9XXVw==", + "dev": true, + "dependencies": { + "cheerio-select": "^1.5.0", + "dom-serializer": "^1.3.2", + "domhandler": "^4.2.0", + "htmlparser2": "^6.1.0", + "parse5": "^6.0.1", + "parse5-htmlparser2-tree-adapter": "^6.0.1", + "tslib": "^2.2.0" + }, + "engines": { + "node": ">= 6" + }, + "funding": { + "url": "https://github.com/cheeriojs/cheerio?sponsor=1" + } + }, + "node_modules/cheerio-select": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/cheerio-select/-/cheerio-select-1.6.0.tgz", + "integrity": "sha512-eq0GdBvxVFbqWgmCm7M3XGs1I8oLy/nExUnh6oLqmBditPO9AqQJrkslDpMun/hZ0yyTs8L0m85OHp4ho6Qm9g==", + "dev": true, + "dependencies": { + "css-select": "^4.3.0", + "css-what": "^6.0.1", + "domelementtype": "^2.2.0", + "domhandler": "^4.3.1", + "domutils": "^2.8.0" + }, + "funding": { + "url": "https://github.com/sponsors/fb55" + } + }, "node_modules/clean-git-ref": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/clean-git-ref/-/clean-git-ref-2.0.1.tgz", @@ -630,6 +689,34 @@ "node": ">=0.8" } }, + "node_modules/css-select": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/css-select/-/css-select-4.3.0.tgz", + "integrity": "sha512-wPpOYtnsVontu2mODhA19JrqWxNsfdatRKd64kmpRbQgh1KtItko5sTnEpPdpSaJszTOhEMlF/RPz28qj4HqhQ==", + "dev": true, + "dependencies": { + "boolbase": "^1.0.0", + "css-what": "^6.0.1", + "domhandler": "^4.3.1", + "domutils": "^2.8.0", + "nth-check": "^2.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/fb55" + } + }, + "node_modules/css-what": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/css-what/-/css-what-6.1.0.tgz", + "integrity": "sha512-HTUrgRJ7r4dsZKU6GjmpfRK1O76h97Z8MfS1G0FozR+oF2kG6Vfe8JE6zwrkbxigziPHinCJ+gCPjA9EaBDtRw==", + "dev": true, + "engines": { + "node": ">= 6" + }, + "funding": { + "url": "https://github.com/sponsors/fb55" + } + }, "node_modules/dateformat": { "version": "4.6.3", "resolved": "https://registry.npmjs.org/dateformat/-/dateformat-4.6.3.tgz", @@ -691,6 +778,61 @@ "integrity": "sha512-iSq8ngPOt0K53A6eVr4d5Kn6GNrM2nQZtC740pzIriHtn4pOQ2lyzEXQMBeVcWERN0ye7fhBsk9PbLLQOnUx/g==", "dev": true }, + "node_modules/dom-serializer": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-1.4.1.tgz", + "integrity": "sha512-VHwB3KfrcOOkelEG2ZOfxqLZdfkil8PtJi4P8N2MMXucZq2yLp75ClViUlOVwyoHEDjYU433Aq+5zWP61+RGag==", + "dev": true, + "dependencies": { + "domelementtype": "^2.0.1", + "domhandler": "^4.2.0", + "entities": "^2.0.0" + }, + "funding": { + "url": "https://github.com/cheeriojs/dom-serializer?sponsor=1" + } + }, + "node_modules/domelementtype": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/domelementtype/-/domelementtype-2.3.0.tgz", + "integrity": "sha512-OLETBj6w0OsagBwdXnPdN0cnMfF9opN69co+7ZrbfPGrdpPVNBUj02spi6B1N7wChLQiPn4CSH/zJvXw56gmHw==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/fb55" + } + ] + }, + "node_modules/domhandler": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-4.3.1.tgz", + "integrity": "sha512-GrwoxYN+uWlzO8uhUXRl0P+kHE4GtVPfYzVLcUxPL7KNdHKj66vvlhiweIHqYYXWlw+T8iLMp42Lm67ghw4WMQ==", + "dev": true, + "dependencies": { + "domelementtype": "^2.2.0" + }, + "engines": { + "node": ">= 4" + }, + "funding": { + "url": "https://github.com/fb55/domhandler?sponsor=1" + } + }, + "node_modules/domutils": { + "version": "2.8.0", + "resolved": "https://registry.npmjs.org/domutils/-/domutils-2.8.0.tgz", + "integrity": "sha512-w96Cjofp72M5IIhpjgobBimYEfoPjx1Vx0BSX9P30WBdZW2WIKU0T1Bd0kz2eNZ9ikjKgHbEyKx8BB6H1L3h3A==", + "dev": true, + "dependencies": { + "dom-serializer": "^1.0.1", + "domelementtype": "^2.2.0", + "domhandler": "^4.2.0" + }, + "funding": { + "url": "https://github.com/fb55/domutils?sponsor=1" + } + }, "node_modules/duplexify": { "version": "4.1.2", "resolved": "https://registry.npmjs.org/duplexify/-/duplexify-4.1.2.tgz", @@ -712,6 +854,15 @@ "once": "^1.4.0" } }, + "node_modules/entities": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-2.2.0.tgz", + "integrity": "sha512-p92if5Nz619I0w+akJrLZH0MX0Pb5DX39XOwQTtXSdQQOaYH03S1uIQp4mhOZtAXrxq4ViO67YTiLBo2638o9A==", + "dev": true, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, "node_modules/esm": { "version": "3.2.25", "resolved": "https://registry.npmjs.org/esm/-/esm-3.2.25.tgz", @@ -1086,6 +1237,41 @@ "node": ">=14" } }, + "node_modules/html-entities": { + "version": "2.3.6", + "resolved": "https://registry.npmjs.org/html-entities/-/html-entities-2.3.6.tgz", + "integrity": "sha512-9o0+dcpIw2/HxkNuYKxSJUF/MMRZQECK4GnF+oQOmJ83yCVHTWgCH5aOXxK5bozNRmM8wtgryjHD3uloPBDEGw==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/mdevils" + }, + { + "type": "patreon", + "url": "https://patreon.com/mdevils" + } + ] + }, + "node_modules/htmlparser2": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-6.1.0.tgz", + "integrity": "sha512-gyyPk6rgonLFEDGoeRgQNaEUvdJ4ktTmmUh/h2t7s+M8oPpIPxgNACWa+6ESR57kXstwqPiCut0V8NRpcwgU7A==", + "dev": true, + "funding": [ + "https://github.com/fb55/htmlparser2?sponsor=1", + { + "type": "github", + "url": "https://github.com/sponsors/fb55" + } + ], + "dependencies": { + "domelementtype": "^2.0.1", + "domhandler": "^4.0.0", + "domutils": "^2.5.2", + "entities": "^2.0.0" + } + }, "node_modules/ieee754": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/ieee754/-/ieee754-1.2.1.tgz", @@ -1367,6 +1553,18 @@ "integrity": "sha512-H5ZhCF25riFd9uB5UCkVKo61m3S/xZk1x4wA6yp/L3RFP6Z/eHH1ymQcGLo7J3GMPfm0V/7m1tryHuGVxpqEBQ==", "dev": true }, + "node_modules/lunr": { + "version": "2.3.9", + "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", + "dev": true + }, + "node_modules/lunr-languages": { + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/lunr-languages/-/lunr-languages-1.9.0.tgz", + "integrity": "sha512-Be5vFuc8NAheOIjviCRms3ZqFFBlzns3u9DXpPSZvALetgnydAN0poV71pVLFn0keYy/s4VblMMkqewTLe+KPg==", + "dev": true + }, "node_modules/mathjax-full": { "version": "3.2.2", "resolved": "https://registry.npmjs.org/mathjax-full/-/mathjax-full-3.2.2.tgz", @@ -1493,6 +1691,18 @@ "node": ">= 0.10" } }, + "node_modules/nth-check": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/nth-check/-/nth-check-2.1.1.tgz", + "integrity": "sha512-lqjrjmaOoAnWfMmBPL+XNnynZh2+swxiX3WUE0s4yEHI6m+AwrK2UZOimIRl3X/4QctVqS8AiZjFqyOGrMXb/w==", + "dev": true, + "dependencies": { + "boolbase": "^1.0.0" + }, + "funding": { + "url": "https://github.com/fb55/nth-check?sponsor=1" + } + }, "node_modules/object-keys": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", @@ -1583,6 +1793,21 @@ "integrity": "sha512-4hLB8Py4zZce5s4yd9XzopqwVv/yGNhV1Bl8NTmCq1763HeK2+EwVTv+leGeL13Dnh2wfbqowVPXCIO0z4taYw==", "dev": true }, + "node_modules/parse5": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/parse5/-/parse5-6.0.1.tgz", + "integrity": "sha512-Ofn/CTFzRGTTxwpNEs9PP93gXShHcTq255nzRYSKe8AkVpZY7e1fpmTfOyoIvjP5HG7Z2ZM7VS9PPhQGW2pOpw==", + "dev": true + }, + "node_modules/parse5-htmlparser2-tree-adapter": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/parse5-htmlparser2-tree-adapter/-/parse5-htmlparser2-tree-adapter-6.0.1.tgz", + "integrity": "sha512-qPuWvbLgvDGilKc5BoicRovlT4MtYT6JfJyBOMDsKoiT+GiuP5qyrPCnR9HcPECIJJmZh5jRndyNThnhhb/vlA==", + "dev": true, + "dependencies": { + "parse5": "^6.0.1" + } + }, "node_modules/path-dirname": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/path-dirname/-/path-dirname-1.0.2.tgz", @@ -2166,6 +2391,12 @@ "node": ">= 0.10" } }, + "node_modules/tslib": { + "version": "2.6.2", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.6.2.tgz", + "integrity": "sha512-AEYxH93jGFPn/a2iVAwW87VuUIkR1FVUKB77NwMF7nBTDkDrrT/Hpt/IrCJ0QXhW27jTBDcf5ZY7w6RiqTMw2Q==", + "dev": true + }, "node_modules/uglify-js": { "version": "3.17.4", "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.17.4.tgz", diff --git a/package.json b/package.json index 35271d3c..828be98e 100644 --- a/package.json +++ b/package.json @@ -15,6 +15,7 @@ }, "devDependencies": { "@antora/cli": "^3.1.7", + "@antora/lunr-extension": "^1.0.0-alpha.8", "@antora/site-generator": "^3.1.7", "@djencks/asciidoctor-mathjax": "^0.0.9" } From 8a358185d6c4f8686ed5c9854b01df4b653a114a Mon Sep 17 00:00:00 2001 From: Shun Sakai Date: Sun, 21 Jan 2024 04:00:33 +0900 Subject: [PATCH 4/6] Update book --- docs/book/supplemental-ui/partials/footer-content.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/book/supplemental-ui/partials/footer-content.hbs b/docs/book/supplemental-ui/partials/footer-content.hbs index 22253d43..81f811be 100644 --- a/docs/book/supplemental-ui/partials/footer-content.hbs +++ b/docs/book/supplemental-ui/partials/footer-content.hbs @@ -1,4 +1,4 @@ From f2f98bb707a699c7d868b041f1da454d28c05ffe Mon Sep 17 00:00:00 2001 From: Shun Sakai Date: Sun, 21 Jan 2024 05:45:24 +0900 Subject: [PATCH 5/6] Minify book when deploying --- .github/workflows/deploy.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml index 81dc1233..4764c12b 100644 --- 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/actions-gh-pages@v3.9.3 if: startsWith(github.ref, 'refs/tags/') From b4e969abbfdec52df630a205035dbbaf366911b3 Mon Sep 17 00:00:00 2001 From: Shun Sakai Date: Sun, 21 Jan 2024 14:18:58 +0900 Subject: [PATCH 6/6] Update version of `abcrypt-cli` to 0.2.12 --- .github/workflows/CD.yaml | 2 +- Cargo.lock | 18 +++++++++--------- crates/abcrypt/Cargo.toml | 2 +- crates/cli/CHANGELOG.adoc | 2 +- crates/cli/Cargo.toml | 4 ++-- 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/.github/workflows/CD.yaml b/.github/workflows/CD.yaml index 5fcb6899..d5e19224 100644 --- 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/install-action@v2.25.2 + uses: taiki-e/install-action@v2.25.7 with: tool: cross - name: Cache build artifacts diff --git a/Cargo.lock b/Cargo.lock index 1f499a7f..a1056511 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -28,7 +28,7 @@ dependencies = [ [[package]] name = "abcrypt-cli" -version = "0.2.11" +version = "0.2.12" dependencies = [ "abcrypt", "anyhow", @@ -129,9 +129,9 @@ checksum = "080e9890a082662b09c1ad45f567faeeb47f22b5fb23895fbe1e651e718e25ca" [[package]] name = "argon2" -version = "0.5.2" +version = "0.5.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "17ba4cac0a46bc1d2912652a751c47f2a9f3a7fe89bcae2275d418f5270402f9" +checksum = "3c3610892ee6e0cbce8ae2700349fcf8f98adb0dbfbee85aec3c9179d29cc072" dependencies = [ "base64ct", "blake2", @@ -378,9 +378,9 @@ dependencies = [ [[package]] name = "clap_complete" -version = "4.4.7" +version = "4.4.8" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "dfb0d4825b75ff281318c393e8e1b80c4da9fb75a6b1d98547d389d6fe1f48d2" +checksum = "eaf7dcb7c21d8ca1a2482ee0f1d341f437c9a7af6ca6da359dc5e1b164e98215" dependencies = [ "clap", ] @@ -756,9 +756,9 @@ dependencies = [ [[package]] name = "proc-macro2" -version = "1.0.76" +version = "1.0.78" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "95fc56cda0b5c3325f5fbbd7ff9fda9e02bb00bb3dac51252d2f1bfa1cb8cc8c" +checksum = "e2422ad645d89c99f8f3e6b88a9fdeca7fabeac836b1002371c4367c8f984aae" dependencies = [ "unicode-ident", ] @@ -1187,9 +1187,9 @@ checksum = "711b9620af191e0cdc7468a8d14e709c3dcdb115b36f838e601583af800a370a" [[package]] name = "uuid" -version = "1.6.1" +version = "1.7.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5e395fcf16a7a3d8127ec99782007af141946b4795001f876d54fb0d55978560" +checksum = "f00cc9702ca12d3c81455259621e676d0f7251cec66a21e98fe2e9a37db93b2a" [[package]] name = "version_check" diff --git a/crates/abcrypt/Cargo.toml b/crates/abcrypt/Cargo.toml index 2e8ab1f4..a3caa0a7 100644 --- 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 index 7cc9bf80..89a30ea0 100644 --- a/crates/cli/CHANGELOG.adoc +++ b/crates/cli/CHANGELOG.adoc @@ -14,7 +14,7 @@ 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\...HEAD[Unreleased] +== {compare-url}/abcrypt-cli-v0.2.11\...abcrypt-cli-v0.2.12[0.2.12] - 2024-01-21 === Changed diff --git a/crates/cli/Cargo.toml b/crates/cli/Cargo.toml index 50caf1f4..5c9fb9c2 100644 --- 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 }