🔄 synced file(s) with upbound/sa-up

[upbound-bot]

synced local file(s) with upbound/sa-up.

Changed files

• synced local Makefile with remote shared/configurations/Makefile
• synced local .github/renovate.json5 with remote shared/configurations/renovate.json5
• synced local .gitmodules with remote shared/configurations/.gitmodules
• created local .github/CODEOWNERS from remote .github/CODEOWNERS

---

This PR was created automatically by the repo-file-sync-action workflow run #12071962598

[Upbound-CLA]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.

---

upbound-bot seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[village-labs-bot]

upbound/platform-ref-aws #206

Change Summary

• Major overhaul of the Makefile with extensive documentation improvements, new targets, and better organization of build configurations
• Added new CODEOWNERS file assigning ownership to the customer success team
• Enhanced renovate.json5 configuration with new package grouping rules and improved regex patterns for dependency management
• Introduction of KCL support in the build system with associated configuration options

Potential Vulnerabilities

• No critical security vulnerabilities identified in the changes

Code Smells

1. Complex Regex Pattern

• File: .github/renovate.json5:50
• Code: "regexManagers": [{"#\\s*renovate:\\s*datasource=(?<datasource>[^\\s]+)\\s+depName=(?<depName>[^\\s]+)\\s*\\n\\s*version:\\s*\"(?<currentValue>[^\"]+)\""]
• Explanation: The regex pattern is complex and hard to maintain. Consider breaking it down into smaller, more manageable patterns or adding detailed comments explaining the matching groups.

2. Hardcoded Timeouts

• File: Makefile:40
• Code: UPTEST_DEFAULT_TIMEOUT ?= 2400s
• Explanation: Hardcoded timeout values should be configurable or documented with reasoning for the specific value chosen.

Debug Logs

• No debug logs found in the changes

Unintended Consequences

1. Team Access Change

• File: .github/CODEOWNERS:1
• Code: * @upbound/team-customer-success
• Explanation: Assigning all files to the customer success team might unintentionally remove visibility or deployment capabilities from other teams who may need access.

2. Build System Change

• File: Makefile:89
• Code: KCL_COMPOSITION_PATH ?= apis/kcl/generate.k
• Explanation: The introduction of KCL support might break existing build pipelines that aren't prepared for this dependency. Teams need to ensure KCL tooling is available in their build environments.

3. Renovate Package Grouping

• File: .github/renovate.json5:12-24
• Code: ```
  "packageRules": [
  {
  "matchFiles": [".github/**"],
  "groupName": "github-actions dependencies"
  },
  ...
  ]

• Explanation: The new package grouping rules might cause all dependencies within a group to be updated simultaneously, which could lead to compatibility issues if not properly tested.

Risk Score: 4

The changes are primarily focused on build system improvements and documentation, with minimal impact on runtime behavior. The main risks come from potential disruption to existing workflows and team access patterns, but these can be easily remedied if issues arise.

[kaessert]

Testing:

$> make render.show
---
apiVersion: aws.platformref.upbound.io/v1alpha1
kind: Cluster
metadata:
  annotations:
    render.crossplane.io/composition-path: apis/pat/composition.yaml
    render.crossplane.io/function-path: examples/functions.yaml
  labels:
    platform.upbound.io/deletion-ordering: enabled
  name: platform-ref-aws
  namespace: default
spec:
  compositeDeletePolicy: Foreground
  parameters:
    gitops:
      git:
        ref:
          name: refs/heads/main
        url: https://github.com/upbound/platform-ref-aws/
    id: platform-ref-aws
    nodes:
      count: 3
      instanceType: t3.small
    region: us-west-2
    version: "1.27"
  writeConnectionSecretToRef:
    name: platform-ref-aws-kubeconfig
status:
  conditions:
  - lastTransitionTime: "2024-01-01T00:00:00Z"
    message: 'Unready resources: XEKS, XFlux, XNetwork, and 6 more'
    reason: Creating
    status: "False"
    type: Ready
---
apiVersion: aws.platform.upbound.io/v1alpha1
kind: XEKS
metadata:
  annotations:
    crossplane.io/composition-resource-name: XEKS
    crossplane.io/external-name: platform-ref-aws
  generateName: platform-ref-aws-
  labels:
    crossplane.io/composite: platform-ref-aws
    platform.upbound.io/deletion-ordering: enabled
    xeks.aws.platform.upbound.io/cluster-id: platform-ref-aws
  ownerReferences:
  - apiVersion: aws.platformref.upbound.io/v1alpha1
    blockOwnerDeletion: true
    controller: true
    kind: Cluster
    name: platform-ref-aws
    uid: ""
spec:
  parameters:
    id: platform-ref-aws
    nodes:
      count: 3
      instanceType: t3.small
    region: us-west-2
    version: "1.27"
---
apiVersion: gitops.platform.upbound.io/v1alpha1
kind: XFlux
metadata:
  annotations:
    crossplane.io/composition-resource-name: XFlux
  generateName: platform-ref-aws-
  labels:
    crossplane.io/composite: platform-ref-aws
  ownerReferences:
  - apiVersion: aws.platformref.upbound.io/v1alpha1
    blockOwnerDeletion: true
    controller: true
    kind: Cluster
    name: platform-ref-aws
    uid: ""
spec:
  parameters:
    providerConfigName: platform-ref-aws
    source:
      git:
        ref:
          name: refs/heads/main
        url: https://github.com/upbound/platform-ref-aws/
---
apiVersion: aws.platform.upbound.io/v1alpha1
kind: XNetwork
metadata:
  annotations:
    crossplane.io/composition-resource-name: XNetwork
  generateName: platform-ref-aws-
  labels:
    crossplane.io/composite: platform-ref-aws
  ownerReferences:
  - apiVersion: aws.platformref.upbound.io/v1alpha1
    blockOwnerDeletion: true
    controller: true
    kind: Cluster
    name: platform-ref-aws
    uid: ""
spec:
  parameters:
    id: platform-ref-aws
    region: us-west-2
---
apiVersion: observe.platform.upbound.io/v1alpha1
kind: XOss
metadata:
  annotations:
    crossplane.io/composition-resource-name: XOss
  generateName: platform-ref-aws-
  labels:
    crossplane.io/composite: platform-ref-aws
  ownerReferences:
  - apiVersion: aws.platformref.upbound.io/v1alpha1
    blockOwnerDeletion: true
    controller: true
    kind: Cluster
    name: platform-ref-aws
    uid: ""
spec:
  parameters:
    id: platform-ref-aws
---
apiVersion: apiextensions.crossplane.io/v1alpha1
kind: Usage
metadata:
  annotations:
    crossplane.io/composition-resource-name: usageXAWSLBControllerByArbitraryLabeledApp
  generateName: platform-ref-aws-
  labels:
    crossplane.io/composite: platform-ref-aws
  ownerReferences:
  - apiVersion: aws.platformref.upbound.io/v1alpha1
    blockOwnerDeletion: true
    controller: true
    kind: Cluster
    name: platform-ref-aws
    uid: ""
spec:
  by:
    apiVersion: platform.upbound.io/v1alpha1
    kind: XApp
    resourceSelector:
      matchLabels:
        platform.upbound.io/deletion-ordering: enabled
  of:
    apiVersion: aws.platform.upbound.io/v1alpha1
    kind: XAWSLBController
    resourceSelector:
      matchControllerRef: true
---
apiVersion: apiextensions.crossplane.io/v1alpha1
kind: Usage
metadata:
  annotations:
    crossplane.io/composition-resource-name: usageXEksByArbitraryLabeledRelease
  generateName: platform-ref-aws-
  labels:
    crossplane.io/composite: platform-ref-aws
  ownerReferences:
  - apiVersion: aws.platformref.upbound.io/v1alpha1
    blockOwnerDeletion: true
    controller: true
    kind: Cluster
    name: platform-ref-aws
    uid: ""
spec:
  by:
    apiVersion: helm.crossplane.io/v1beta1
    kind: Release
    resourceSelector:
      matchLabels:
        platform.upbound.io/deletion-ordering: enabled
  of:
    apiVersion: aws.platform.upbound.io/v1alpha1
    kind: XEKS
    resourceSelector:
      matchControllerRef: true
---
apiVersion: apiextensions.crossplane.io/v1alpha1
kind: Usage
metadata:
  annotations:
    crossplane.io/composition-resource-name: usageXEksByXFlux
  generateName: platform-ref-aws-
  labels:
    crossplane.io/composite: platform-ref-aws
  ownerReferences:
  - apiVersion: aws.platformref.upbound.io/v1alpha1
    blockOwnerDeletion: true
    controller: true
    kind: Cluster
    name: platform-ref-aws
    uid: ""
spec:
  by:
    apiVersion: gitops.platform.upbound.io/v1alpha1
    kind: XFlux
    resourceSelector:
      matchControllerRef: true
  of:
    apiVersion: aws.platform.upbound.io/v1alpha1
    kind: XEKS
    resourceSelector:
      matchControllerRef: true
---
apiVersion: apiextensions.crossplane.io/v1alpha1
kind: Usage
metadata:
  annotations:
    crossplane.io/composition-resource-name: usageXEksByXOss
  generateName: platform-ref-aws-
  labels:
    crossplane.io/composite: platform-ref-aws
  ownerReferences:
  - apiVersion: aws.platformref.upbound.io/v1alpha1
    blockOwnerDeletion: true
    controller: true
    kind: Cluster
    name: platform-ref-aws
    uid: ""
spec:
  by:
    apiVersion: observe.platform.upbound.io/v1alpha1
    kind: XOss
    resourceSelector:
      matchControllerRef: true
  of:
    apiVersion: aws.platform.upbound.io/v1alpha1
    kind: XEKS
    resourceSelector:
      matchControllerRef: true
---
apiVersion: apiextensions.crossplane.io/v1alpha1
kind: Usage
metadata:
  annotations:
    crossplane.io/composition-resource-name: usageXNetworkByXEKS
  generateName: platform-ref-aws-
  labels:
    crossplane.io/composite: platform-ref-aws
  ownerReferences:
  - apiVersion: aws.platformref.upbound.io/v1alpha1
    blockOwnerDeletion: true
    controller: true
    kind: Cluster
    name: platform-ref-aws
    uid: ""
spec:
  by:
    apiVersion: aws.platform.upbound.io/v1alpha1
    kind: XEKS
    resourceSelector:
      matchControllerRef: true
  of:
    apiVersion: aws.platform.upbound.io/v1alpha1
    kind: XNetwork
    resourceSelector:
      matchControllerRef: true

$> make check-examples
12:33:59 [ .. ] Checking if package versions in dependencies match examples
12:33:59 [ OK ] Package versions are sane

[kaessert]

/test-examples

[kaessert]

/test-examples