diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..f077d85 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,18 @@ +# Changelog + +## [Unreleased] + +## [v0.1.0] - 2024-03-27 + +### Added + +- CRD generator. +- Go code generator. +- Tested compatibility with Kubernetes v1.28. +- Tested compatibility with Kubernetes v1.27. +- Tested compatibility with Kubernetes v1.29. +- Docker image uses `kubernetes/code-generator` v1.30.0-beta.0. +- Docker image uses `kubernetes-sigs/controller-tools` v0.14.0. + +[unreleased]: https://github.com/slok/kube-code-generator/compare/v0.1.0...HEAD +[v0.1.0]: https://github.com/slok/kube-code-generator/releases/tag/v0.1.0 diff --git a/README.md b/README.md index 277e0c9..fa734fc 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ The easiest way is to use the provided Docker image as it has all the required u Here is an example that mounts the current directory (a Go project) and generates the Go code and the CRDs by providing the APIs input directory and the generation output directories: ```bash -docker run -it --rm -v ${PWD}:/app ghcr.io/slok/kube-code-generator \ +docker run -it --rm -v ${PWD}:/app ghcr.io/slok/kube-code-generator \ --apis-in ./apis \ --go-gen-out ./gen \ --crd-gen-out ./gen/manifests @@ -46,10 +46,18 @@ However, the best way to know how to use it is with a full example, you have it ## Kubernetes versions -| Kubernetes | Docker image | -| ---------- | ------------------------------------------------------- | -| v1.29 | `docker pull ghcr.io/slok/kube-code-generator:v1.29.0` | +It's suggested that if you don't have an old Kubenretes version, you try the latest kube-code-generator +(`latest`), however the ones described on the table here are known to work correctly on the specific version. -### Versions =v1.29` and changes the usage of the app, so for other versions you will need to check the previous implementation I would suggest that you check the [Readme of `