Releases: Skarlso/crd-to-sample-yaml
v1.0.4
v1.0.3
Release v1.0.3
The following features have been completed in this release:
v1.0.2
Release v1.0.2
This release adds a small adjustment to the JSON schema generator adding
a small detail about the kind and the group and the version that's being
used by the schema.
v1.0.1
Release v1.0.1
Fix ignoring the random flag for HTML output.
v1.0.0
Release v1.0.0
💥 BREAKING CHANGE 💥
This is the first official 1.0.0 version of CRD sample. This tool has come a long way
from simply generating sample YAML files from CRDs. It now supports the following
major features:
- CRD testing
- Generating JSON schemas
- Validating more types other than CRD that support openAPIV3schema section in their
specfield - Generating minimum required yamls
- Adding comments
- Generating YAML that 100% conforms to the given schema, respecting minimum values, regex, formats, etc.
- A feature rich website with
- live code changes rendering
- back navigation
- lots of tiny options
This has been quite the journey. Hopefully, from now on, the API will be somewhat stable. I can't promise completey
unbreakable changes, but I promise not to break anything in Patch versions.
v0.12.0
Release v0.12.0
💥 WARNING! This release contains a breaking change. 💥
I restructured the CLI api. Now, generate is a top level command. It has
TWO subcommands called crd and scheme. Pull request number #119
introduced a new feature where you are now able to generate a JSON schema
from a CRD. This is useful for auto-generating completion schemas and further
tooling support that uses raw JSON schemas.
v0.11.0
Release v0.11.0
This release brings with it a huge update. First, and formost,
v1beta1 support has been added to CRDs. This will now successfully
generate values for Validate entities that don't have any versions
listed.
Another huge update is to the frontend. The frontend contains now a
textare that can be edited and the content will be generated on the fly
instead of having to send the content to be rendered.
And lastley, the whole repo has a test now that uses the created
test suite to make sure that all rendering is still working after
an update.
v0.10.0
Release v0.10.0
- updated the website to have a true back button once rendering is complete
- added multiple CRD display options for the rendered HTML page
v0.9.0
v0.9.0
This update brings with it some version upgrades and changes how
required fields are calculated for minimum samples. That is
samples that satisfy the minimum required fields present in a CRD.
It will render fields better.
Also fixed a problem where {} would not be rendered in case
a top level object was required but didn't had any more required
fields it self. In that case, it would be rendered as field: and
that's it. Which made the schema fail.
Now, a {} is correctly put after it if it's an object. For example:
apiVersion: v1
kind: Whatever
spec:
fields: {}v0.8.0
v0.8.0
MAJOR UPDATE
Changes to how values are generated
This update contains a few modifications to the way we generate samples. These modifications are the following:
- if enum values are defined for a property, choose the first one from the list whatever that is
- if there is a minimum defined for integer types, the minimum value is used
- comment is added to list items of what type they are and how much the minimum value for them is
volumeIDs: [] # minItems 0 of type string- unless
no-randomis defined, now given aPatternthat contains a valid regex a valid value is generated that satisfies the regex
and the regex's value is commented after the value
name: xwjhylgy2ruc # ^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$The random generation can be skipped by providing the following flag to cty: --no-random.
New test command
A new command has been added that lets users unit test schema validation for generated YAML files to CRDs.
To read more about it, check out the readme: crd-testing-README.md.