From bc5a5bc6bf44205f38b58bce5ba70d998dcb9dde Mon Sep 17 00:00:00 2001 From: Arnaud Mimart <33665250+amimart@users.noreply.github.com> Date: Tue, 2 Apr 2024 15:33:08 +0200 Subject: [PATCH 1/3] chore: enforce jq version 1.7 to generate docs --- Makefile.toml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Makefile.toml b/Makefile.toml index 19c9f1ea..909147be 100644 --- a/Makefile.toml +++ b/Makefile.toml @@ -129,6 +129,12 @@ echo "๐Ÿงน Cleaning old documentation..." rm -rf $SCHEMA_FOLDER rm -rf $DOCS_FOLDER +if [[ $(jq --version) != jq-1\.7* ]] +then + echo "Error: jq version 1.7 is needed" + exit 1 +fi + echo "๐Ÿ“š Generating documentation in ${DOCS_FOLDER} folder..." mkdir -p $SCHEMA_FOLDER From acaa0c18c2e46fc971a4ea25eb9a081156a18a48 Mon Sep 17 00:00:00 2001 From: Arnaud Mimart <33665250+amimart@users.noreply.github.com> Date: Tue, 2 Apr 2024 15:33:28 +0200 Subject: [PATCH 2/3] docs: update generated docs --- docs/okp4-cognitarium.md | 2 +- docs/okp4-dataverse.md | 2 +- docs/okp4-law-stone.md | 2 +- docs/okp4-objectarium.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/okp4-cognitarium.md b/docs/okp4-cognitarium.md index 8c379c55..6802877a 100644 --- a/docs/okp4-cognitarium.md +++ b/docs/okp4-cognitarium.md @@ -876,4 +876,4 @@ Represents a condition in a [WhereClause]. --- -_Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `okp4-cognitarium.json` (`6f72bb04e2230e19`)_ +_Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `okp4-cognitarium.json` (`a04a40216c76a302`)_ diff --git a/docs/okp4-dataverse.md b/docs/okp4-dataverse.md index c5c197ce..5baedc66 100644 --- a/docs/okp4-dataverse.md +++ b/docs/okp4-dataverse.md @@ -238,5 +238,5 @@ let b = Uint64::from(70u32); assert_eq!(b.u64(), 70); ``` --- -*Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `okp4-dataverse.json` (`b906ba32d6e0720c`)* +*Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `okp4-dataverse.json` (`6c4e48ca82d04a6a`)* ```` diff --git a/docs/okp4-law-stone.md b/docs/okp4-law-stone.md index 10d46c10..c2bd8275 100644 --- a/docs/okp4-law-stone.md +++ b/docs/okp4-law-stone.md @@ -134,4 +134,4 @@ A string containing Base64-encoded data. --- -_Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `okp4-law-stone.json` (`f92ef76322c09083`)_ +_Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `okp4-law-stone.json` (`1c8e531eb7eea016`)_ diff --git a/docs/okp4-objectarium.md b/docs/okp4-objectarium.md index 83fc5971..d8310590 100644 --- a/docs/okp4-objectarium.md +++ b/docs/okp4-objectarium.md @@ -511,4 +511,4 @@ A string containing a 128-bit integer in decimal representation. --- -_Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `okp4-objectarium.json` (`b4d8508c7abc145b`)_ +_Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `okp4-objectarium.json` (`483acdc660c72c5f`)_ From aa7af9921de85ee899389888bac7977da135a465 Mon Sep 17 00:00:00 2001 From: Arnaud Mimart <33665250+amimart@users.noreply.github.com> Date: Tue, 2 Apr 2024 15:48:30 +0200 Subject: [PATCH 3/3] chore: move make jq install check in prerequisite task --- Makefile.toml | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/Makefile.toml b/Makefile.toml index 909147be..0b6c3fa9 100644 --- a/Makefile.toml +++ b/Makefile.toml @@ -119,6 +119,14 @@ then exit 1 fi echo "โœ… \`perl\` installed" + +echo "โ” Checking \`jq\` installation..." +if [[ $(jq --version) != jq-1\.7* ]] +then + echo "\nโŒ Require jq version 1.7" + exit 1 +fi +echo "โœ… \`jq\` installed" ''' [tasks.docs-generate] @@ -129,12 +137,6 @@ echo "๐Ÿงน Cleaning old documentation..." rm -rf $SCHEMA_FOLDER rm -rf $DOCS_FOLDER -if [[ $(jq --version) != jq-1\.7* ]] -then - echo "Error: jq version 1.7 is needed" - exit 1 -fi - echo "๐Ÿ“š Generating documentation in ${DOCS_FOLDER} folder..." mkdir -p $SCHEMA_FOLDER