Autodesk / Autodesk/shore

Shore should setup a validated API contract between the CLI and Renderer

Open
#58 0 comments 0 reactions 0 assignees View on GitHub
bug DevX good first issue Renderer-JSONNET Shore-CLI
Dominant language
Go
Stars
21
Forks
4
PR merge metrics
No merged PRs in 30d

Description

Currently missing parameters are not easily testable.
During manifestation of JSonnet, params are read from Render.yaml and passed to the render.

Missing parameters aren't debuggable due to the amount of abstraction introduced by Shore.

The error produced when running with an empty empty `render.yml` file:
```
ERRO[0000] Renderer.Render returned an error RUNTIME ERROR: Field does not exist: application
/Users/liberms/code/platform/testshore/main.pipeline.jsonnet:5:20-38 object
During manifestation
RUNTIME ERROR: Field does not exist: application
/Users/liberms/code/platform/testshore/main.pipeline.jsonnet:5:20-38 object
During manifestation
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by tracing how the CLI reads parameters from Render.yaml or an empty render.yml and passes them to Renderer.Render during manifestation. Review the current error path and the boundary between the CLI and Renderer. Done means missing parameters are validated at that boundary and produce an actionable, testable error instead of the Jsonnet field-missing message.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api, cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.