From 56eecd40660926a370a013d160144a51510dab5c Mon Sep 17 00:00:00 2001 From: racfop Date: Thu, 7 Sep 2023 09:08:58 -0700 Subject: [PATCH 1/2] Squashed 'schemas/' content from commit 99610a4 git-subtree-dir: schemas git-subtree-split: 99610a46d9c00654a5d7966e2e77dcf5d5fc3904 --- LICENSE | 201 ++++++++++++++++++++++++++++ README.md | 34 +++++ score-v1b1.json | 340 ++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 575 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 score-v1b1.json diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..261eeb9e --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + 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. diff --git a/README.md b/README.md new file mode 100644 index 00000000..e5cc499f --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# JSON schemas for Score files + +| version | file | +| --- | --- | +| v1-beta1 | score-v1b1.json | + +## Embed schemas into project + +Add Score schemas into projects with `git subtree add` command: + +``` +git subtree add \ + --prefix schemas \ + git@github.com:score-spec/schema.git main \ + --squash +``` + +> **Note:** To avoid storing the entire history of the sub-project in the main repository, make sure to include `--squash` flag. + +## Update schemas from upstream + +Get the latest versions of the schemas `git subtree pull` command: + +``` +git subtree pull \ + --prefix schemas \ + git@github.com:score-spec/schema.git main \ + --squash +``` + +## Contribute changes to upstream + +All changes to `score-spec/schema` should be done via pull requests and comply with the review and sign-off policies. + diff --git a/score-v1b1.json b/score-v1b1.json new file mode 100644 index 00000000..fa932be8 --- /dev/null +++ b/score-v1b1.json @@ -0,0 +1,340 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$id": "https://score.dev/schemas/score", + "title": "Score schema", + "description": "Score workload specification", + "type": "object", + "required": [ + "apiVersion", + "metadata", + "containers" + ], + "additionalProperties": false, + "properties": { + "apiVersion": { + "description": "The declared Score Specification version.", + "type": "string" + }, + "metadata": { + "description": "The metadata description of the Workload.", + "type": "object", + "required": [ + "name" + ], + "additionalProperties": true, + "properties": { + "name": { + "description": "A string that can describe the Workload.", + "type": "string" + } + } + }, + "service": { + "description": "The service that the workload provides.", + "type": "object", + "additionalProperties": false, + "properties": { + "ports": { + "description": "List of network ports published by the service.", + "type": "object", + "additionalProperties": true, + "minProperties": 1, + "patternProperties": { + "^*": { + "description": "The network port description.", + "type": "object", + "required": [ + "targetPort" + ], + "additionalProperties": false, + "properties": { + "port": { + "description": "The public service port.", + "type": "number" + }, + "targetPort": { + "description": "The internal service port.", + "type": "number" + } + } + } + } + } + } + }, + "containers": { + "description": "The declared Score Specification version.", + "type": "object", + "additionalProperties": true, + "minProperties": 1, + "patternProperties": { + "^*": { + "description": "The container name.", + "type": "object", + "required": [ + "image" + ], + "additionalProperties": false, + "properties": { + "image": { + "description": "The image name and tag.", + "type": "string" + }, + "command": { + "description": "If specified, overrides container entry point.", + "type": "array", + "minItems": 1, + "items": { + "type": "string" + } + }, + "args": { + "description": "If specified, overrides container entry point arguments.", + "type": "array", + "minItems": 1, + "items": { + "type": "string" + } + }, + "variables": { + "description": "The environment variables for the container.", + "type": "object", + "minProperties": 1, + "additionalProperties": { + "type": "string" + } + }, + "files": { + "description": "The extra files to mount.", + "type": "array", + "minItems": 1, + "items": { + "type": "object", + "required": [ + "target" + ], + "properties": { + "target": { + "description": "The file path and name.", + "type": "string" + }, + "mode": { + "description": "The file access mode.", + "type": "string" + }, + "source": { + "description": "The relative or absolute path to the content file.", + "type": "string", + "minLength": 1 + }, + "content": { + "description": "The inline content for the file.", + "anyOf": [{ + "type": "string" + }, { + "deprecated": true, + "type": "array", + "minItems": 1, + "items": { + "type": "string" + } + }] + }, + "noExpand": { + "description": "If set to true, the placeholders expansion will not occur in the contents of the file.", + "type": "boolean" + } + }, + "oneOf": [{ + "required": ["content"] + }, { + "required": ["source"] + }] + } + }, + "volumes": { + "description": "The volumes to mount.", + "type": "array", + "minItems": 1, + "items": { + "type": "object", + "required": [ + "source", + "target" + ], + "properties": { + "source": { + "description": "The external volume reference.", + "type": "string" + }, + "path": { + "description": "An optional sub path in the volume.", + "type": "string" + }, + "target": { + "description": "The target mount on the container.", + "type": "string" + }, + "read_only": { + "description": "Indicates if the volume should be mounted in a read-only mode.", + "type": "boolean" + } + } + } + }, + "resources": { + "description": "The compute resources for the container.", + "type": "object", + "minProperties": 1, + "additionalProperties": false, + "properties": { + "limits": { + "description": "The maximum allowed resources for the container.", + "$ref": "#/properties/containers/definitions/resourcesLimits" + }, + "requests": { + "description": "The minimal resources required for the container.", + "$ref": "#/properties/containers/definitions/resourcesLimits" + } + } + }, + "livenessProbe": { + "description": "The liveness probe for the container.", + "$ref": "#/properties/containers/definitions/containerProbe" + }, + "readinessProbe": { + "description": "The readiness probe for the container.", + "$ref": "#/properties/containers/definitions/containerProbe" + } + } + } + }, + "definitions": { + "resourcesLimits": { + "description": "The compute resources limits.", + "type": "object", + "minProperties": 1, + "additionalProperties": false, + "properties": { + "memory": { + "description": "The memory limit.", + "type": "string" + }, + "cpu": { + "description": "The CPU limit.", + "type": "string" + } + } + }, + "containerProbe": { + "type": "object", + "minProperties": 1, + "additionalProperties": false, + "properties": { + "httpGet": { + "$ref": "#/properties/containers/definitions/httpProbe" + } + } + }, + "httpProbe": { + "description": "An HTTP probe details.", + "type": "object", + "additionalProperties": false, + "required": [ + "path" + ], + "properties": { + "host": { + "description": "Host name to connect to. Defaults to the container IP.", + "type": "string" + }, + "scheme": { + "description": "Scheme to use for connecting to the host (HTTP or HTTPS). Defaults to HTTP.", + "type": "string", + "enum": [ + "HTTP", + "HTTPS" + ] + }, + "path": { + "description": "The path of the HTTP probe endpoint.", + "type": "string" + }, + "port": { + "description": "The path of the HTTP probe endpoint.", + "type": "number" + }, + "httpHeaders": { + "description": "Additional HTTP headers to send with the request", + "type": "array", + "minItems": 1, + "items": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "description": "The HTTP header name.", + "type": "string" + }, + "value": { + "description": "The HTTP header value.", + "type": "string" + } + } + } + } + } + } + } + }, + "resources": { + "description": "The dependencies needed by the Workload.", + "type": "object", + "minProperties": 1, + "additionalProperties": true, + "patternProperties": { + "^*": { + "description": "The resource name.", + "type": "object", + "additionalProperties": false, + "required": [ + "type" + ], + "properties": { + "type": { + "description": "The resource in the target environment.", + "type": "string" + }, + "metadata": { + "description": "The metadata for the resource.", + "type": "object", + "minProperties": 1, + "additionalProperties": true, + "properties": { + "annotations": { + "description": "Annotations that apply to the property.", + "type": "object", + "minProperties": 1, + "additionalProperties": { + "type": "string" + } + } + } + }, + "properties": { + "description": "DEPRECATED: The properties that can be referenced in other places in the Score Specification file.", + "type": [ + "object", + "null" + ] + }, + "params": { + "description": "The parameters used to validate or provision the resource in the environment.", + "type": "object" + } + } + } + } + } + } +} From e85c91355e3f136e28cbbf618caeb753b6d0e852 Mon Sep 17 00:00:00 2001 From: racfop Date: Thu, 7 Sep 2023 09:32:38 -0700 Subject: [PATCH 2/2] Adds Schema as git module --- .../docs/reference/score-schema-reference.md | 341 +----------------- dprint.json | 4 +- layouts/shortcodes/include.html | 52 +-- layouts/shortcodes/includeJSON.html | 9 + schemas/README.md | 5 +- 5 files changed, 43 insertions(+), 368 deletions(-) create mode 100644 layouts/shortcodes/includeJSON.html diff --git a/content/en/docs/reference/score-schema-reference.md b/content/en/docs/reference/score-schema-reference.md index 7171df8a..ed0df49c 100644 --- a/content/en/docs/reference/score-schema-reference.md +++ b/content/en/docs/reference/score-schema-reference.md @@ -8,341 +8,6 @@ description: > The Score schema is a JSON schema that defines the structure of a Score file. It's used to validate the Score file before an implementation CLI (such as `score-compose` or `score-helm`) is executed. The Score implementation CLI validates the Score file against the schema before generating the platform-specific configuration, by default. -```json -{ - "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://score.dev/schemas/score", - "title": "Score schema", - "description": "Score workload specification", - "type": "object", - "required": [ - "apiVersion", - "metadata", - "containers" - ], - "additionalProperties": false, - "properties": { - "apiVersion": { - "description": "The declared Score Specification version.", - "type": "string" - }, - "metadata": { - "description": "The metadata description of the Workload.", - "type": "object", - "required": [ - "name" - ], - "additionalProperties": true, - "properties": { - "name": { - "description": "A string that can describe the Workload.", - "type": "string" - } - } - }, - "service": { - "description": "The service that the workload provides.", - "type": "object", - "additionalProperties": false, - "properties": { - "ports": { - "description": "List of network ports published by the service.", - "type": "object", - "additionalProperties": true, - "minProperties": 1, - "patternProperties": { - "^*": { - "description": "The network port description.", - "type": "object", - "required": [ - "targetPort" - ], - "additionalProperties": false, - "properties": { - "port": { - "description": "The public service port.", - "type": "number" - }, - "targetPort": { - "description": "The internal service port.", - "type": "number" - } - } - } - } - } - } - }, - "containers": { - "description": "The declared Score Specification version.", - "type": "object", - "additionalProperties": true, - "minProperties": 1, - "patternProperties": { - "^*": { - "description": "The container name.", - "type": "object", - "required": [ - "image" - ], - "additionalProperties": false, - "properties": { - "image": { - "description": "The image name and tag.", - "type": "string" - }, - "command": { - "description": "If specified, overrides container entry point.", - "type": "array", - "minItems": 1, - "items": { - "type": "string" - } - }, - "args": { - "description": "If specified, overrides container entry point arguments.", - "type": "array", - "minItems": 1, - "items": { - "type": "string" - } - }, - "variables": { - "description": "The environment variables for the container.", - "type": "object", - "minProperties": 1, - "additionalProperties": { "type": "string" } - }, - "files": { - "description": "The extra files to mount.", - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "target", - "content" - ], - "properties": { - "target": { - "description": "The file path and name.", - "type": "string" - }, - "mode": { - "description": "The file access mode.", - "type": "string" - }, - "content": { - "description": "The inline content for the file.", - "type": "array", - "minItems": 1, - "items": { - "type": "string" - } - } - } - } - }, - "volumes": { - "description": "The volumes to mount.", - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "source", - "target" - ], - "properties": { - "source": { - "description": "The external volume reference.", - "type": "string" - }, - "path": { - "description": "An optional sub path in the volume.", - "type": "string" - }, - "target": { - "description": "The target mount on the container.", - "type": "string" - }, - "read_only": { - "description": "Indicates if the volume should be mounted in a read-only mode.", - "type": "boolean" - } - } - } - }, - "resources": { - "description": "The compute resources for the container.", - "type": "object", - "minProperties": 1, - "additionalProperties": false, - "properties": { - "limits": { - "description": "The maximum allowed resources for the container.", - "$ref": "#/properties/containers/definitions/resourcesLimits" - }, - "requests": { - "description": "The minimal resources required for the container.", - "$ref": "#/properties/containers/definitions/resourcesLimits" - } - } - }, - "livenessProbe": { - "description": "The liveness probe for the container.", - "type": "object", - "minProperties": 1, - "additionalProperties": false, - "properties": { - "httpGet": { - "description": "", - "$ref": "#/properties/containers/definitions/httpProbe" - } - } - }, - "readinessProbe": { - "description": "The readiness probe for the container.", - "type": "object", - "minProperties": 1, - "additionalProperties": false, - "properties": { - "httpGet": { - "description": "", - "$ref": "#/properties/containers/definitions/httpProbe" - } - } - } - } - } - }, - "definitions": { - "resourcesLimits": { - "description": "The compute resources limits.", - "type": "object", - "minProperties": 1, - "additionalProperties": false, - "properties": { - "memory": { - "description": "The memory limit.", - "type": "string" - }, - "cpu": { - "description": "The CPU limit.", - "type": "string" - } - } - }, - "httpProbe": { - "description": "An HTTP probe details.", - "type": "object", - "additionalProperties": false, - "required": [ - "path" - ], - "properties": { - "path": { - "description": "The path of the HTTP probe endpoint.", - "type": "string" - }, - "port": { - "description": "The path of the HTTP probe endpoint.", - "type": "number" - }, - "httpHeaders": { - "description": "Additional HTTP headers to send with the request", - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "additionalProperties": false, - "properties": { - "name": { - "description": "The HTTP header name.", - "type": "string" - }, - "value": { - "description": "The HTTP header value.", - "type": "string" - } - } - } - } - } - } - } - }, - "resources": { - "description": "The dependencies needed by the Workload.", - "type": "object", - "minProperties": 1, - "additionalProperties": true, - "patternProperties": { - "^*": { - "description": "The resource name.", - "type": "object", - "additionalProperties": false, - "required": [ - "type" - ], - "properties": { - "type": { - "description": "The resource in the target environment.", - "type": "string" - }, - "metadata": { - "description": "The metadata for the resource.", - "type": "object", - "minProperties": 1, - "additionalProperties": true, - "properties": { - "annotations": { - "description": "Annotattions that apply to the property.", - "type": "object", - "minProperties": 1, - "additionalProperties": { "type": "string" } - } - } - }, - "properties": { - "description": "The properties that can be referenced in other places in the Score Specification file.", - "type": "object", - "minProperties": 1, - "patternProperties": { - "^*": { - "description": "The property name.", - "type": ["object", "null"], - "minProperties": 1, - "additionalProperties": false, - "properties": { - "type": { - "description": "The property value type.", - "type": "string" - }, - "default": { - "description": "A value that applies for the property by default.", - "type": ["integer", "string", "boolean"] - }, - "required": { - "description": "Indictes if the property value is requred.", - "type": "boolean" - }, - "secret": { - "description": "Indicates if the property value contains sensitive information.", - "type": "boolean" - } - } - } - } - }, - "params": { - "description": "The parameters used to validate or provision the resource in the environment.", - "type": "object" - } - } - } - } - } - } -} -``` + + +{{< includeJSON "schemas/score-v1b1.json" >}} diff --git a/dprint.json b/dprint.json index 364fd585..1d25cdee 100644 --- a/dprint.json +++ b/dprint.json @@ -26,10 +26,10 @@ ], "plugins": [ "https://plugins.dprint.dev/typescript-0.71.2.wasm", - "https://plugins.dprint.dev/json-0.15.5.wasm", + "https://plugins.dprint.dev/json-0.17.4.wasm", "https://plugins.dprint.dev/markdown-0.14.0.wasm", "https://plugins.dprint.dev/toml-0.5.4.wasm", "https://plugins.dprint.dev/dockerfile-0.3.0.wasm", - "https://plugins.dprint.dev/prettier-0.11.0.json@385edfc0e1212b3be6412cda49322ecd62cb38ac71b9b463869bebf23a4767e3" + "https://plugins.dprint.dev/prettier-0.27.0.json@3557a62b4507c55a47d8cde0683195b14d13c41dda66d0f0b0e111aed107e2fe" ] } \ No newline at end of file diff --git a/layouts/shortcodes/include.html b/layouts/shortcodes/include.html index e14807c0..d000cc2e 100644 --- a/layouts/shortcodes/include.html +++ b/layouts/shortcodes/include.html @@ -1,27 +1,29 @@ -{{/* This will try to find a resource in the "includes" bundle */}} +{{/* Get the resource name. If missing, throw an error. */}} {{- $name := .Get 0 -}} -{{- if $name -}} - {{- $bundle := site.GetPage "page" "includes" -}} - {{- with $bundle -}} - {{- $pattern := printf "%s*" $name -}} - {{- range $bundle.Resources -}} - {{- end -}} - {{- $resource := $bundle.Resources.GetMatch $pattern -}} - {{- with $resource -}} - {{- .Content | safeHTML -}} - {{- else -}} - {{/* It is not a resource in the includes bundle. Try to find the page relative to the current. */}} - {{- $path := path.Join $.Page.File.Dir $name -}} - {{- $page := site.GetPage "page" $path -}} - {{- with $page }} - {{ .Content }} - {{- else -}} - {{ errorf "[%s] no Resource or Page matching %q." $.Page.Lang ($pattern | safeHTML ) }} - {{- end -}} - {{- end -}} - {{- else -}} - {{ errorf "[%s] the 'includes' bundle was not found." $.Page.Lang }} - {{- end -}} +{{- if not $name -}} + {{- errorf "[%s] missing resource name in include for page %q" $.Page.Lang $.Page.Path -}} + {{- return -}} +{{- end -}} + +{{/* Define the pattern for matching resources. */}} +{{- $pattern := printf "%s*" $name -}} + +{{/* Try to find the resource in the "includes" bundle. */}} +{{- $bundle := site.GetPage "page" "includes" -}} +{{- if $bundle -}} + {{- $resource := $bundle.Resources.GetMatch $pattern -}} + {{- with $resource -}} + {{- .Content | safeHTML -}} + {{- return -}} + {{- end -}} +{{- end -}} + +{{/* If not in the "includes" bundle, try to find a relative page. */}} +{{- $path := path.Join $.Page.File.Dir $name -}} +{{- $page := site.GetPage "page" $path -}} +{{- with $page -}} + {{ .Content }} + {{- return -}} {{- else -}} - {{- errorf "[%s] missing resource name in include for page %q" $.Page.Lang $.Page.Path -}} -{{- end -}} \ No newline at end of file + {{- errorf "[%s] no Resource or Page matching %q." $.Page.Lang ($pattern | safeHTML ) -}} +{{- end -}} diff --git a/layouts/shortcodes/includeJSON.html b/layouts/shortcodes/includeJSON.html new file mode 100644 index 00000000..ce52d58d --- /dev/null +++ b/layouts/shortcodes/includeJSON.html @@ -0,0 +1,9 @@ +{{/* Read the file and save its content to a variable */}} +{{ $content := readFile (printf "%s" (.Get 0)) }} + +{{/* Display the file content, you can add more styling or process it further if needed */}} +
+
+{{ $content | safeHTML }}
+
+
diff --git a/schemas/README.md b/schemas/README.md index e5cc499f..8749fb09 100644 --- a/schemas/README.md +++ b/schemas/README.md @@ -1,7 +1,7 @@ # JSON schemas for Score files -| version | file | -| --- | --- | +| version | file | +| -------- | --------------- | | v1-beta1 | score-v1b1.json | ## Embed schemas into project @@ -31,4 +31,3 @@ git subtree pull \ ## Contribute changes to upstream All changes to `score-spec/schema` should be done via pull requests and comply with the review and sign-off policies. -