IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2024-11-29 12:14:08 -06:00
Code Issues Packages Projects Releases Wiki Activity
80ef96e213
grafana/hack
History
Kyle Brandt 959c80daf6
k8S: (Chore) Add arg to hack codegen to filter openapi generation (#81720)
2024-02-01 11:06:51 -05:00
..
boilerplate.go.txt K8s: fix standalone command and add hack scripts (#79052) 2023-12-05 14:31:49 -08:00
externalTools.go K8s: update hack codegen script (#81216) 2024-01-25 12:01:09 -08:00
make-aggregator-pki.sh Grafana app platform: an aggregator cmd and package (#79948) 2024-01-08 22:33:42 +02:00
openapi-codegen.sh K8s: update hack codegen script (#81216) 2024-01-25 12:01:09 -08:00
README.md K8s: update hack codegen script (#81216) 2024-01-25 12:01:09 -08:00
update-codegen.sh k8S: (Chore) Add arg to hack codegen to filter openapi generation (#81720) 2024-02-01 11:06:51 -05:00

README.md

Kubernetes HACK Alert

This is a hack folder for kubernetes codegen scripts. Oddly, a /hack/ folder seems to be standard kubernetes development practice ¯_(ツ)_/¯

The workflow is a WIP, however we are trying to leverage as many off-the-shelf patterns as possible.

For these scripts to work, your local GOROOT/src/grafana/grafana must point to this git checkout. For my setup this is:

❯ pwd
/Users/ryan/go/src/github.com/grafana
❯ ls -l
total 0
lrwxr-xr-x  1 ryan  staff  37 Oct  5 09:34 grafana -> /Users/ryan/workspace/grafana/grafana

The current workflow is to run the following:

# ensure k8s.io/code-generator pkg is up to date
go mod download

# the happy path
./hack/update-codegen.sh

# if wanting to agree to a change which introduces different openapi violations, run with the bool set to true
UPDATE_API_KNOWN_VIOLATIONS=true ./hack/update-codegen.sh

Note that the script deletes existing openapi go code and regenerates in place so that you will temporarily see deleted files in your git status. After a successful run, you should see them restored.