Skip to content

Commit

Permalink
add documentation on how to create a new release for the composition …
Browse files Browse the repository at this point in the history
…function and pkl packages

Signed-off-by: Tim <[email protected]>
  • Loading branch information
Avarei committed Jun 30, 2024
1 parent ce3e9a4 commit d8272ca
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,16 +64,26 @@ $ crossplane xpkg build -f package --embed-runtime-image=runtime
$ crossplane xpkg push -f function-pkl*.xpkg ghcr.io/crossplane-contrib/function-pkl

# Resolve Pkl Project Dependencies
$ pkl project resolve
$ pkl project resolve ./pkl/*/

# Package the Pkl Project
$ pkl project package
$ pkl project package ./pkl/*/

# Debugging this function
# While a Debugging session is running run on the same host:
$ crossplane beta render xr.yaml composition.yaml functions.yaml --verbose
```

### Creating a new Release
#### Composition Function
Run the [CI action](https://github.com/crossplane-contrib/function-pkl/actions/workflows/ci.yml) and provide a Package version.
#### Pkl Packages
Update `PklProject.package.version` of the relevant Package in ./pkl/

Create a Tag in the style of <PklProject.package.name>@<PklProject.package.version> e.g. `git tag [email protected]`

Push it `git push --tags`

### Pkl Function Flow
This Chart illustrates how what happens, when Crossplane Triggers this Composition Function.

Expand Down

0 comments on commit d8272ca

Please sign in to comment.