https://github.com/dolittle/contracts-compatibility
A tool to resolve compatible versions of the Dolittle Runtime and SDKs
https://github.com/dolittle/contracts-compatibility
Last synced: 3 months ago
JSON representation
A tool to resolve compatible versions of the Dolittle Runtime and SDKs
- Host: GitHub
- URL: https://github.com/dolittle/contracts-compatibility
- Owner: dolittle
- License: mit
- Created: 2022-03-15T20:02:12.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-08T14:13:27.000Z (almost 3 years ago)
- Last Synced: 2025-01-01T09:10:28.159Z (5 months ago)
- Language: Go
- Homepage:
- Size: 42 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Dolittle Contracts Compatibility tool
The `contracts-compatibility` checks what versions of the Dolittle [Runtime](https://github.com/dolittle/Runtime) and
SDKs that are compatible with each other. And can generate a Markdown table or a JSON structure. Currently, the tool
checks the [DotNet SDK](https://github.com/dolittle/DotNET.SDK) and the
[JavaScript SDK](https://github.com/dolittle/JavaScript.SDK). It was built to generate the compatibility table on
[dolittle.io](https://dolittle.io/docs/reference/runtime/compatibility/), and for other internal uses.
Usage:
```shell
$ contracts-compatibility -h
Contracts Compatibility a tool to resolve compatible versions of the Dolittle Runtime and SDKs
Usage:
-h Print help information
-o string
Output format [markdown,json] (default "markdown")
```
Running the tool fetches all currently released versions from the public repositories, and resolves the compatible
versions.
> **Warning**: for the Runtime, the tool fetches the Docker manifests from Docker Hub without authentication. Since
> there are quite a few released versions, this quickly eats into your IPs rate limits. So be careful about running it
> a lot of times. Read more on the
> [Docker Hub rate limit documentation](https://docs.docker.com/docker-hub/download-rate-limit/#definition-of-limits).
### How to run it
The tool is released as a Docker image on
[dolittle/contracts-compatibility](https://hub.docker.com/r/dolittle/contracts-compatibility), so the simplest way to
get started is to run:
```shell
$ docker run dolittle/contracts-compatibility
```
If you want to try it from source (you need Go 1.18 or greater), in the repository root, run:
```shell
$ go run .
```