Skip to content

Commit

Permalink
added readme update and release doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Skarlso committed Dec 11, 2023
1 parent f2f5140 commit 64ea0fe
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Expand Up @@ -57,6 +57,33 @@ make run

This will start a front-end that can be used to paste in and parse CRDs.

## Comments

Comments can be added to each line of the generated YAML content where descriptions are available. This looks something
like this:

```yaml
# APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
# Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind: AWSCluster
metadata: {}
# AWSClusterSpec defines the desired state of an EC2-based Kubernetes cluster.
spec:
# AdditionalTags is an optional set of tags to add to AWS resources managed by the AWS provider, in addition to the ones added by default.
additionalTags: {}
# Bastion contains options to configure the bastion host.
bastion:
...
```

To add comments simply run cty with:
```console
cty generate -c sample-crd/infrastructure.cluster.x-k8s.io_awsclusters.yaml --comments
```

The frontend also has a checkbox to add comments to the generated yaml output.

## Showcase

![frontpage](./imgs/frontend.png)
Expand Down
3 changes: 3 additions & 0 deletions docs/release_notes/v0.2.0.md
@@ -0,0 +1,3 @@
# v0.2.0 Release

This release adds optionally generated comments to the mix.

0 comments on commit 64ea0fe

Please sign in to comment.