crossplane
/
docs
mirror of https://github.com/crossplane/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clarify that not all functions should delete the input directory 

Signed-off-by: Nic Cope <nicc@rk0n.org>
This commit is contained in:
Nic Cope 2023-10-31 18:14:48 -07:00
parent fde689dd71
commit 47e6e77a9c
1 changed files with 14 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
content/knowledge-base/guides/write-a-composition-function-in-go.md
View File

@ -120,7 +120,6 @@ You must make some changes before you start adding code:
* Edit `package/crossplane.yaml` to change the package's name. * Edit `package/crossplane.yaml` to change the package's name.
* Edit `go.mod` to change the Go module's name. * Edit `go.mod` to change the Go module's name.
* Delete the `input` and `package/input` directories.
Name your package `function-xbuckets`. Name your package `function-xbuckets`.
@ -128,20 +127,25 @@ The name of your module depends on where you want to keep your function code. If
you push Go code to GitHub, you can use your GitHub username. For example you push Go code to GitHub, you can use your GitHub username. For example
`module github.com/negz/function-xbuckets`. `module github.com/negz/function-xbuckets`.
The function in this guide doesn't use an input type. For this function you
should delete the `input` and `package/input` directories.
The `input` directory defines a Go struct that a function can use to take input, The `input` directory defines a Go struct that a function can use to take input,
using the `input` field from a Composition. The using the `input` field from a Composition. The
[composition functions]({{<ref "../../master/concepts/composition-functions">}}) [composition functions]({{<ref "../../master/concepts/composition-functions">}})
documentation explains how to pass an input to a composition function. This documentation explains how to pass an input to a composition function.
function doesn't use an input, so you should delete the `input` directory.
You should also delete the `package/input` directory. It contains an OpenAPI The `package/input` directory contains an OpenAPI schema generated from the
schema automatically generated from the structs in the `input` directory. structs in the `input` directory.
{{<hint "tip">}} {{<hint "important">}}
If you're writing a function that does use an input type, rename the type from If you're writing a function that does use an input type, don't delete the
`Input` to something more specific to your function. For example `input` and `package/input` directories.
Function Patch and Transform names its input type `Resources`. Rename the API
version too by updating the `// +groupName` comment at the top of `input.go`. Instead rename the type from `Input` to something more specific to your
function. For example Function Patch and Transform names its input type
`Resources`. Rename the API version too by updating the `// +groupName` comment
at the top of `input.go`.
When you edit files under the `input` directory you must update some generated When you edit files under the `input` directory you must update some generated
files by running `go generate`. See `input/generate.go` for details. files by running `go generate`. See `input/generate.go` for details.