https://github.com/aserto-dev/ts-decision-logs
Aserto Decision Logs TypeScript type definitions.
https://github.com/aserto-dev/ts-decision-logs
Last synced: about 1 year ago
JSON representation
Aserto Decision Logs TypeScript type definitions.
- Host: GitHub
- URL: https://github.com/aserto-dev/ts-decision-logs
- Owner: aserto-dev
- License: apache-2.0
- Created: 2022-12-20T09:36:39.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-20T09:58:02.000Z (over 3 years ago)
- Last Synced: 2025-03-16T07:27:29.920Z (over 1 year ago)
- Language: TypeScript
- Size: 22.5 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ts-decision-logs
Automated generation of Aserto Decision Logs TypeScript type definitions.
## Consuming the definitions
These definitions can be consumed by `yarn` from npm:
```
"devDependencies": {
"@aserto/ts-decision-logs": "^v0.0.1",
```
or directly from `git` using the following reference:
```
"devDependencies": {
"@aserto/ts-decision-logs": "git+https://github.com/aserto-dev/ts-decision-logs.git#v0.0.1",
```
Replace `v0.0.1` with the tag you would like to use.
## Generation Process
- `OPENAPI_SAH=main yarn generate`
## GitHub Workflow
The GitHub Workflow is triggered as a workflow_dispatch. It expects to be provided with two required parameters:
- PROTO_REF: The version tag of `aserto-dev/pb-decision-logs` that is represented by the `OPENAPI_SHA`. This is used to tag the `ts-decision-logs` commit with the same proto version.
- OPENAPI_SHA: The `aserto-dev/openapi-decision-logs` commit hash for which type definitions should be created.
Using these variables the GitHub Workflow runs the same `./generate.sh` script, commits, and tags its results for downstream consumption. Run results are deterministic as explicit commit hash and version numbers are taken as explicit input parameters.