chore: refined workflows

Author: Luca Bianconi

.github/workflows/release-go-task.yml

@@ -254,12 +254,10 @@ jobs:
         run: task protoc:collect
 
       - name: Add configuration JSON schema
-        run: |
-          TAG=${{ needs.create-release-artifacts.outputs.version }}
-          cp ./configuration/configuration.schema.json ${{ env.DIST_DIR}}/${TAG}-configuration.schema.json
+        run: task dist:jsonschema
 
       - name: Create checksum file
-        working-directory: ${{ env.DIST_DIR}}
+        working-directory: ${{ env.DIST_DIR }}
         run: |
           TAG=${{ needs.create-release-artifacts.outputs.version }}
           sha256sum ${{ env.PROJECT_NAME }}_${TAG}* > ${TAG}-checksums.txt

.gitignore

@@ -28,3 +28,4 @@ venv
 /docsgen/arduino-cli.exe
 /docs/rpc/*.md
 /docs/commands/*.md
+/docs/configuration.schema.json

Taskfile.yml

@@ -9,6 +9,7 @@ tasks:
     deps:
       - task: go:cli-docs
       - task: protoc:docs
+      - task: docs:include-configuration-json-schema
     cmds:
       - task: general:format-prettier
 
@@ -218,6 +219,11 @@ tasks:
       - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,settings.md --proto_path=rpc ./rpc/cc/arduino/cli/settings/v1/*.proto'
       - '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,debug.md --proto_path=rpc ./rpc/cc/arduino/cli/debug/v1/*.proto'
 
+  docs:include-configuration-json-schema:
+    desc: Copy configuration JSON schema to make it available in documentation
+    cmds:
+      - cp ./configuration/configuration.schema.json ./docs/configuration.schema.json
+
   protoc:check:
     desc: Perform linting of the protobuf definitions
     cmds:

docs/configuration.md

@@ -105,6 +105,9 @@ The configuration file must be named `arduino-cli`, with the appropriate file ex
 - envfile
 - [INI]
 
+The configuration file [JSON schema][configuration-schema] can be used to independently validate the file content. This
+schema should be considered unstable in this version.
+
 #### Locations
 
 Configuration files in the following locations are recognized by Arduino CLI:
@@ -158,3 +161,4 @@ additional_urls = [ "https://downloads.arduino.cc/packages/package_staging_index
 [java properties file]: https://en.wikipedia.org/wiki/.properties
 [hcl]: https://github.com/hashicorp/hcl
 [ini]: https://en.wikipedia.org/wiki/INI_file
+[configuration-schema]: ./configuration.schema.json