components-contrib/.build-tools
Alessandro (Ale) Segala f15a50581d
Component metadata schema and tools (#2077)
* Component metadata schema and tools

Includes tools to generate and validate components' schema, and a CI check to ensure the schema is always up-to-date.

Also, includes schemas for 4 components as a starter

Signed-off-by: ItalyPaleAle <43508+ItalyPaleAle@users.noreply.github.com>

* Changed version as requested

Signed-off-by: ItalyPaleAle <43508+ItalyPaleAle@users.noreply.github.com>

* fix workflow

Signed-off-by: Bernd Verst <4535280+berndverst@users.noreply.github.com>

Signed-off-by: ItalyPaleAle <43508+ItalyPaleAle@users.noreply.github.com>
Signed-off-by: Bernd Verst <4535280+berndverst@users.noreply.github.com>
Co-authored-by: Bernd Verst <4535280+berndverst@users.noreply.github.com>
2022-09-27 10:44:54 -07:00
..
cmd Component metadata schema and tools (#2077) 2022-09-27 10:44:54 -07:00
pkg Component metadata schema and tools (#2077) 2022-09-27 10:44:54 -07:00
.gitignore Component metadata schema and tools (#2077) 2022-09-27 10:44:54 -07:00
README.md Component metadata schema and tools (#2077) 2022-09-27 10:44:54 -07:00
component-folders.json Component metadata schema and tools (#2077) 2022-09-27 10:44:54 -07:00
go.mod Component metadata schema and tools (#2077) 2022-09-27 10:44:54 -07:00
go.sum Component metadata schema and tools (#2077) 2022-09-27 10:44:54 -07:00
main.go Component metadata schema and tools (#2077) 2022-09-27 10:44:54 -07:00

README.md

dapr/components-contrib build-tools CLI

This folder contains a CLI that implements a number of build tools used by dapr/components-contrib.

The CLI is written in Go and based on the cobra framework. In order to use it, Go (1.18+) must be installed on your system.

Running the CLI

You have two ways to run the CLI:

  1. Within the build-tools directly, you can run the CLI with go run . directly. For example go run . help shows the help page.
  2. You can build a pre-compiled binary by running make compile-build-tools in the root folder of this repository. This will build an executable called build-tools (or build-tools.exe on Windows) in the build-tools folder. You can then run the command directly, for example ./build-tools help

Available commands

The list of available commands in this CLI is dynamic and is subject to change at any time. Each command, including the "root" one (no sub-command), are self-documented in the CLI, and you can read the help page by adding --help.

For example, ./build-tools --help shows the full list of commands the CLI offers.