https://github.com/tilt-dev/tilt-starlark-docs-codegen

Generates starlark function docs based on Kubernetes API models
https://github.com/tilt-dev/tilt-starlark-docs-codegen

Last synced: 11 days ago
JSON representation

Generates starlark function docs based on Kubernetes API models

• Host: GitHub
• URL: https://github.com/tilt-dev/tilt-starlark-docs-codegen
• Owner: tilt-dev
• License: apache-2.0
• Created: 2021-09-10T19:03:33.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2021-11-02T14:32:37.000Z (over 4 years ago)
• Last Synced: 2025-02-21T23:18:23.311Z (over 1 year ago)
• Language: Go
• Size: 34.2 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# tilt-starlark-docs-codegen

[![Build Status](https://circleci.com/gh/tilt-dev/tilt-starlark-docs-codegen/tree/main.svg?style=shield)](https://circleci.com/gh/tilt-dev/tilt-starlark-docs-codegen)

Generates starlark API documentation based on Kubernetes-style API models

This repo is intended for:

1) Developers who want to add new data models to Tilt, then auto-generate docs for the

Tiltfile DSL.

2) Developers who want to see a simple example of Go-based code generators based

on Kubernetes' [gengo](https://pkg.go.dev/k8s.io/gengo)

## Usage

```

# Sample input and output

tilt-starlark-docs-codegen ./path/to/input ./path/to/output

# In the Tilt codebase

tilt-starlark-docs-codegen ./pkg/apis/core/v1alpha1 ../tilt.build/api/modules/v1alpha1

# Dry run (print to stdout)

tilt-starlark-docs-codegen ./pkg/apis/core/v1alpha1 -

```