diff --git a/.github/workflows/ci-thing-model.yaml b/.github/workflows/ci-thing-model.yaml index 870d881..f5c6d0a 100644 --- a/.github/workflows/ci-thing-model.yaml +++ b/.github/workflows/ci-thing-model.yaml @@ -1,4 +1,4 @@ -name: TM Helpers CI Pipeline +name: Thing Model CI Pipeline on: push: diff --git a/README.md b/README.md index cc23367..0ada2db 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,18 @@ +[![AAS AID CI Pipeline](https://github.com/eclipse-thingweb/td-tools/actions/workflows/ci-aas-aid.yaml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/ci-aas-aid.yaml) +[![AsyncAPI Converter CI Pipeline](https://github.com/eclipse-thingweb/td-tools/actions/workflows/ci-async-api-converter.yaml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/ci-async-api-converter.yaml) +[![OpenAPI Converter CI Pipeline](https://github.com/eclipse-thingweb/td-tools/actions/workflows/ci-open-api-converter.yaml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/ci-open-api-converter.yaml) +[![JSON Spell Checker CI Pipeline](https://github.com/eclipse-thingweb/td-tools/actions/workflows/ci-json-spell-checker.yaml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/ci-json-spell-checker.yaml) +[![TD Utils CI Pipeline](https://github.com/eclipse-thingweb/td-tools/actions/workflows/ci-td-utils.yaml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/ci-td-utils.yaml) +[![Thing Model CI Pipeline](https://github.com/eclipse-thingweb/td-tools/actions/workflows/ci-thing-model.yaml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/ci-thing-model.yaml) + +[![CodeQL](https://github.com/eclipse-thingweb/td-tools/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/codeql-analysis.yml) +[![ESLint](https://github.com/eclipse-thingweb/td-tools/actions/workflows/eslint.yml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/eslint.yml) +[![Prettier](https://github.com/eclipse-thingweb/td-tools/actions/workflows/prettier.yml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/prettier.yml) +[![codecov](https://codecov.io/gh/eclipse-thingweb/td-tools/branch/main/graph/badge.svg?token=ZP8VZROLXD)](https://codecov.io/gh/eclipse-thingweb/td-tools) + The goal of this repository is to contain different tools for Thing Descriptions and Thing Models. Currently, they are scattered in different Thingweb repositories and packages and they will be moved here. diff --git a/node/aas-aid/README.md b/node/aas-aid/README.md index 2b995c6..f21d1d7 100644 --- a/node/aas-aid/README.md +++ b/node/aas-aid/README.md @@ -1,5 +1,10 @@ # Eclipse Thingweb - AAS AID tooling for WoT Thing Descriptions +[![AAS AID CI Pipeline](https://github.com/eclipse-thingweb/td-tools/actions/workflows/ci-aas-aid.yaml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/ci-aas-aid.yaml) +[![CodeQL](https://github.com/eclipse-thingweb/td-tools/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/codeql-analysis.yml) +[![ESLint](https://github.com/eclipse-thingweb/td-tools/actions/workflows/eslint.yml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/eslint.yml) +[![Prettier](https://github.com/eclipse-thingweb/td-tools/actions/workflows/prettier.yml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/prettier.yml) + The package provides tooling for Asset Adminstration Shell (AAS) w.r.t. Asset Interfaces Description (AID). The [IDTA Asset Interfaces Description (AID) working group](https://github.com/admin-shell-io/submodel-templates/tree/main/development/Asset%20Interface%20Description/1/0) defines a submodel template specification for the Asset Adminstration Shell that can be used to describe the asset's service interface or asset's related service interfaces. The current AID working assumptions reuse existing definitions from [WoT Thing Descriptions](https://www.w3.org/TR/wot-thing-description11/). Hence it is possible to consume AAS with AID definitions with [node-wot](https://github.com/eclipse-thingweb/node-wot) (e.g., read/subscribe live data of the asset and/or associated service). diff --git a/node/async-api-converter/README.md b/node/async-api-converter/README.md index db6c5ee..5756520 100644 --- a/node/async-api-converter/README.md +++ b/node/async-api-converter/README.md @@ -1,5 +1,10 @@ # Eclipse Thingweb - TD to AsyncAPI Converter +[![AsyncAPI Converter CI Pipeline](https://github.com/eclipse-thingweb/td-tools/actions/workflows/ci-async-api-converter.yaml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/ci-async-api-converter.yaml) +[![CodeQL](https://github.com/eclipse-thingweb/td-tools/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/codeql-analysis.yml) +[![ESLint](https://github.com/eclipse-thingweb/td-tools/actions/workflows/eslint.yml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/eslint.yml) +[![Prettier](https://github.com/eclipse-thingweb/td-tools/actions/workflows/prettier.yml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/prettier.yml) + The package provides support for AsyncAPI instance generation (output as `json` or `yaml`), using a Thing Description (TD) as input. ## Usage diff --git a/node/json-spell-checker/README.md b/node/json-spell-checker/README.md index 9d589ca..28183f5 100644 --- a/node/json-spell-checker/README.md +++ b/node/json-spell-checker/README.md @@ -1,5 +1,10 @@ # Eclipse Thingweb - JSON Spell Checker +[![JSON Spell Checker CI Pipeline](https://github.com/eclipse-thingweb/td-tools/actions/workflows/ci-json-spell-checker.yaml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/ci-json-spell-checker.yaml) +[![CodeQL](https://github.com/eclipse-thingweb/td-tools/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/codeql-analysis.yml) +[![ESLint](https://github.com/eclipse-thingweb/td-tools/actions/workflows/eslint.yml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/eslint.yml) +[![Prettier](https://github.com/eclipse-thingweb/td-tools/actions/workflows/prettier.yml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/prettier.yml) + This package provides spell-checking support for JSON files when a JSON Schema is given. Limitations: diff --git a/node/open-api-converter/README.md b/node/open-api-converter/README.md index 83d9d4b..efb46e6 100644 --- a/node/open-api-converter/README.md +++ b/node/open-api-converter/README.md @@ -1,5 +1,10 @@ # Eclipse Thingweb - TD to OpenAPI Converter +[![OpenAPI Converter CI Pipeline](https://github.com/eclipse-thingweb/td-tools/actions/workflows/ci-open-api-converter.yaml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/ci-open-api-converter.yaml) +[![CodeQL](https://github.com/eclipse-thingweb/td-tools/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/codeql-analysis.yml) +[![ESLint](https://github.com/eclipse-thingweb/td-tools/actions/workflows/eslint.yml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/eslint.yml) +[![Prettier](https://github.com/eclipse-thingweb/td-tools/actions/workflows/prettier.yml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/prettier.yml) + The package supports OpenAPI instance generation (output as `json` or `yaml`), using a Thing Description (TD) as input. ## Usage diff --git a/node/td-utils/README.md b/node/td-utils/README.md index 0bd841d..2d2a72f 100644 --- a/node/td-utils/README.md +++ b/node/td-utils/README.md @@ -1,5 +1,10 @@ # Eclipse Thingweb - TD Utils +[![TD Utils CI Pipeline](https://github.com/eclipse-thingweb/td-tools/actions/workflows/ci-td-utils.yaml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/ci-td-utils.yaml) +[![CodeQL](https://github.com/eclipse-thingweb/td-tools/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/codeql-analysis.yml) +[![ESLint](https://github.com/eclipse-thingweb/td-tools/actions/workflows/eslint.yml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/eslint.yml) +[![Prettier](https://github.com/eclipse-thingweb/td-tools/actions/workflows/prettier.yml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/prettier.yml) + The package provides utility tools for TDs, such as: - Detecting protocol schemes in a TD diff --git a/node/thing-model/README.md b/node/thing-model/README.md index 5f255c4..24f358a 100644 --- a/node/thing-model/README.md +++ b/node/thing-model/README.md @@ -1,5 +1,10 @@ # Eclipse Thingweb - TM Helpers +[![Thing Model CI Pipeline](https://github.com/eclipse-thingweb/td-tools/actions/workflows/ci-thing-model.yaml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/ci-thing-model.yaml) +[![CodeQL](https://github.com/eclipse-thingweb/td-tools/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/codeql-analysis.yml) +[![ESLint](https://github.com/eclipse-thingweb/td-tools/actions/workflows/eslint.yml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/eslint.yml) +[![Prettier](https://github.com/eclipse-thingweb/td-tools/actions/workflows/prettier.yml/badge.svg)](https://github.com/eclipse-thingweb/td-tools/actions/workflows/prettier.yml) + The package provides helper tools for Thing Models. Tools help to: