Merge pull request #92 from ytsarev/quickstart-fixes

Fixes for `xpkg init` generation recommendations and CI workflow for uppercase github org names

Author: phisco

.github/workflows/ci.yml

@@ -164,4 +164,6 @@ jobs:
 
       - name: Push Multi-Platform Package to Upbound
         if: env.XPKG_ACCESS_ID != ''
-        run: "./crossplane --verbose xpkg push --package-files $(echo *.xpkg|tr ' ' ,) ${{ env.XPKG }}:${{ env.XPKG_VERSION }}"
+        # XPKG repo name can't contain uppercase characters like UpboundCare, we need to lowercase if the GithubOrg contains them.
+        # See https://github.com/orgs/community/discussions/25768#discussioncomment-8057564 for XPKG@L lowercase explanation
+        run: "./crossplane --verbose xpkg push --package-files $(echo *.xpkg|tr ' ' ,) ${XPKG@L}:${{ env.XPKG_VERSION }}"

NOTES.txt

@@ -3,7 +3,7 @@ To get started:
 1. Replace `function-template-go` with your function in `go.mod`,
    `package/crossplane.yaml`, and any Go imports. (You can also do this
    automatically by running the `./init.sh <function-name>` script.)
-2. Update `input/v1beta1/` to reflect your desired input (and run `go generate`)
+2. Update `input/v1beta1/` to reflect your desired input (and run `go generate ./...`)
 3. Add your logic to `RunFunction` in `fn.go`
 4. Add tests for your logic in `fn_test.go`
-5. Update `README.md`, to be about your function!
+5. Update `README.md`, to be about your function!

README.md

@@ -14,7 +14,7 @@ If you just want to jump in and get started:
 1. Replace `function-template-go` with your function in `go.mod`,
    `package/crossplane.yaml`, and any Go imports. (You can also do this
    automatically by running the `./init.sh <function-name>` script.)
-1. Update `input/v1beta1/` to reflect your desired input (and run `go generate`)
+1. Update `input/v1beta1/` to reflect your desired input (and run `go generate ./...`)
 1. Add your logic to `RunFunction` in `fn.go`
 1. Add tests for your logic in `fn_test.go`
 1. Update this file, `README.md`, to be about your function!
@@ -41,4 +41,4 @@ $ crossplane xpkg build -f package --embed-runtime-image=runtime
 [function guide]: https://docs.crossplane.io/knowledge-base/guides/write-a-composition-function-in-go
 [package docs]: https://pkg.go.dev/github.com/crossplane/function-sdk-go
 [docker]: https://www.docker.com
-[cli]: https://docs.crossplane.io/latest/cli
+[cli]: https://docs.crossplane.io/latest/cli