npx [email protected] crd command outputs .ts files that must be edited before use

[btlghrants]

Environment

Device and OS: Ubuntu 24.04
App version: v3.0.2
Kubernetes distro being used: n/a

Definition of Done

• e2e test (in Kubernetes Fluent Client)
• No manual intervention

Potential look at the e2e test around PolicyReports

Steps to reproduce

1. Run this command:

   npx [email protected] crd https://github.com/kubernetes-sigs/wg-policy-prototypes/raw/master /policy-report/crd/v1alpha2/wgpolicyk8s.io_clusterpolicyreports.yaml $(pwd)
   

2. Open the generated files with a TS-aware IDE.

Expected result

An error-free .ts file should be generated.

Actual Result

The requested .ts file is generated but it has TS errors.

Visual Proof (screenshots, videos, text, etc)

Severity/Priority

Annoying

Additional Context

Problem can be worked around by manually editing the generated files, but... that's annoying to have to do.

[mjnagel]

In my case I'm also seeing some weirdness around spec for my generated CRD. Typically we resolve this by deleting the apiVersion, kind, metadata, and changing spec to spec?.

Example to reproduce:

npx kubernetes-fluent-client crd https://raw.githubusercontent.com/prometheus-operator/prometheus-operator/v0.76.1/example/prometheus-operator-crd/monitoring.coreos.com_podmonitors.yaml <some file path to put CRD type>

[btlghrants]

Found a link to the "fix" I was using during Dash Days PolicyReport excellent example.

https://github.com/defenseunicorns/pepr-excellent-examples/blob/ade93b0142086dce50eae6df180618b8d9f9261e/_helpers/dev/cli.mts#L164

This was built into the dev CLI (as a hack) but could probably be used as a starting point for polishing / moving into Pepr.

[github-actions]

🎉 This issue has been resolved in version 3.0.4 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀