Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# pkl-codegen
A collection of docker images to generate code bindings for pkl models (in either Swift, Java, or Kotlin). Also supports PklDoc generation.

Current builds are created for pkl version 0.29.0, 0.29.1, 0.30.0, 0.30.1, 0.30.2 and 0.31.0.
Current builds are created for pkl version 0.29.0, 0.29.1, 0.30.0, 0.30.1, 0.30.2, 0.31.0 and 0.31.1.

## Usage
Given an input model of `example.pkl`, you can generate a code binding for a selected platform and pkl version using the following command:
Expand All @@ -10,10 +10,10 @@ Given an input model of `example.pkl`, you can generate a code binding for a sel
docker run --rm -v "./:/data" ghcr.io/emilymclean/pkl-codegen-<platform>:<version> /data/example.pkl -o /data/java
```

So, for Kotlin using pkl version 0.31.0:
So, for Kotlin using pkl version 0.31.1:

```sh
docker run --rm -v "./:/data" ghcr.io/emilymclean/pkl-codegen-kotlin:0.31.0 /data/example.pkl -o /data/java
docker run --rm -v "./:/data" ghcr.io/emilymclean/pkl-codegen-kotlin:0.31.1 /data/example.pkl -o /data/java
```

The supported platforms/images are as follows:
Expand All @@ -27,4 +27,4 @@ The supported platforms/images are as follows:
| PklDoc | `pkl-codegen-doc` |

### Versioning
Versions of the container generally adhere to the following versioning format: `<pkl version>-<container release version>`. For example, for pkl `0.31.0` and release `1.0.0`, this would be `0.31.0-1.0.0`. In addition, a tag for the container major version, nightly version, and major+nightly version is also published. In the same circumstance as above, this would be `0.31.0-1`, `0.31.0-nightly`, and `0.31.0-1-nightly` respectively. It is **highly** recommended to at least pin to a major version to prevent breaking changes from accidentally interfering with use.
Versions of the container generally adhere to the following versioning format: `<pkl version>-<container release version>`. For example, for pkl `0.31.1` and release `1.0.0`, this would be `0.31.1-1.0.0`. In addition, a tag for the container major version, nightly version, and major+nightly version is also published. In the same circumstance as above, this would be `0.31.1-1`, `0.31.1-nightly`, and `0.31.1-1-nightly` respectively. It is **highly** recommended to at least pin to a major version to prevent breaking changes from accidentally interfering with use.
1 change: 1 addition & 0 deletions pkl-versions
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
0.30.1
0.30.2
0.31.0
0.31.1
Loading