From eabf13ba71a741c70f6a0990de6f9f66f2439aa3 Mon Sep 17 00:00:00 2001 From: Steven Borrelli Date: Fri, 6 Feb 2026 15:26:15 -0600 Subject: [PATCH 1/2] fix example link Signed-off-by: Steven Borrelli --- README.md | 6 +++--- test-cases/README.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f20ca8f..e34f0f4 100644 --- a/README.md +++ b/README.md @@ -154,7 +154,7 @@ To develop Compositions using Typescript, the following is recommended: │ └── main.ts # Entry point and server setup ├── test-cases/ # YAML-based test cases │ ├── README.md # Test case documentation -│ └── example-full.yaml # Example test case +│ └── example.yaml # Example test case ├── examples/ # Example Crossplane resources │ ├── apps/ # Example application resources │ └── functions.yaml # Function pipeline configuration @@ -259,7 +259,7 @@ node dist/main.js --insecure --debug Once the function is running locally, `crossplane render` can be used to render examples: ```shell -crossplane render examples/app/example-full.yaml package-configuration/apis/apps/composition.yaml examples/functions.yaml +crossplane render examples/app/example.yaml package-configuration/apis/apps/composition.yaml examples/functions.yaml ``` ### Available CLI Options @@ -533,7 +533,7 @@ Create YAML test cases in the [test-cases/](test-cases/) directory. Each test ca - Input: The observed composite resource and context - Expected: Resource counts, types, and validation rules -See [test-cases/example-full.yaml](test-cases/example-full.yaml) for an example. Tests use [src/test-helpers.ts](src/test-helpers.ts) to load and validate YAML test cases. +See [test-cases/example.yaml](test-cases/example.yaml) for an example. Tests use [src/test-helpers.ts](src/test-helpers.ts) to load and validate YAML test cases. ## TypeScript Configuration diff --git a/test-cases/README.md b/test-cases/README.md index 2c5ea96..fce1723 100644 --- a/test-cases/README.md +++ b/test-cases/README.md @@ -40,7 +40,7 @@ name: Test Case Name description: Optional description of what this test validates # Load the composite resource from an external file -xrPath: examples/apps/example-full.yaml +xrPath: examples/apps/example.yaml expected: # Expected number of resources to be created @@ -136,7 +136,7 @@ expected: { "name": "Test Case Name", "description": "Optional description", - "xrPath": "examples/apps/example-full.yaml", + "xrPath": "examples/apps/example.yaml", "expected": { "resourceCount": 4, "resourceTypes": ["Deployment", "Service", "ServiceAccount", "Ingress"] From 9f8dec7ec78450ce9c7a8cf627c090deee9a7890 Mon Sep 17 00:00:00 2001 From: Steven Borrelli Date: Fri, 6 Feb 2026 15:44:52 -0600 Subject: [PATCH 2/2] add example link Signed-off-by: Steven Borrelli --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index e34f0f4..3d223da 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,8 @@ This template provides a full Typescript project for developing Crossplane funct The initial [src/function.ts](src/function.ts) creates sample Deployment, Ingress, Service, and ServiceAccount resources and can be customized to create any type of Kubernetes resource. +For an example of configuring cloud resources, refer to [configuration-aws-network-ts](https://github.com/upbound/configuration-aws-network-ts). + ## Running the Example Package The configuration and function are published to the [Upbound Marketplace](https://marketplace.upbound.io),