Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

upbound-bot
Copy link

@upbound-bot upbound-bot commented Nov 28, 2024

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

Changed files
  • synced local Makefile with remote shared/configurations/Makefile
  • synced local directory .github/workflows with remote directory shared/configurations/workflows
  • 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 #12196606044

@Upbound-CLA
Copy link

Upbound-CLA commented Nov 28, 2024

CLA assistant check
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.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link

upbound/platform-ref-gcp #112

Change Summary

  • Major Makefile overhaul with expanded documentation and new development tools/targets including yamllint, check-examples, render tests, and e2e testing improvements
  • Update of core dependencies including UP_VERSION (v0.28.0 -> v0.35.0), new CROSSPLANE_CLI_VERSION, and UPTEST_VERSION (v0.11.1 -> v1.2.0)
  • Changed build submodule URL from upbound/build to crossplane/build.git and added new CODEOWNERS file assigning ownership to customer success team
  • Enhanced renovate configuration with new package grouping rules and git-submodules support

Potential Vulnerabilities

  • Explanation: Changing the build submodule source could potentially introduce security risks if the new repository is not properly vetted or maintained. Need to ensure the crossplane/build repository has appropriate security controls and review processes.

Code Smells

    • File: Makefile:214-244
    • Code: help.local: @echo "Available targets:" @echo @grep -E '^[a-zA-Z_-]+.*:.*?## .*$$' Makefile | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
    • Explanation: Complex one-liner using grep/awk for help text generation. While functional, it's hard to read and maintain. Consider breaking this into a separate script or simplifying the approach.
    • File: Makefile:185-196
    • Code: render.test: $(CROSSPLANE_CLI) $(KCL) render ## Test rendered compositions @for RENDERED_COMPOSITION in $$(find .cache/render -maxdength 1 -type f -name '*.yaml'); do \ $(INFO) "Testing $${RENDERED_COMPOSITION}"; \ export RENDERED_COMPOSITION; \ $(KCL) test test/ && \ $(OK) "Success testing \"$${RENDERED_COMPOSITION}\"!" || \ ($(ERR) "Failure testing \"$${RENDERED_COMPOSITION}\"!" && exit 1); \ done
    • Explanation: Shell script logic embedded in Makefile is generally harder to maintain and test. Consider moving complex test logic to a separate script file.

Unintended Consequences

    • File: .github/renovate.json5:71-73
    • Code: "git-submodules": { "enabled": true }
    • Explanation: Enabling automatic git submodule updates could lead to unexpected build breaks if the crossplane/build repository makes breaking changes. Consider pinning to specific versions or tags instead of auto-updating.
    • File: Makefile:19-20
    • Code: CROSSPLANE_VERSION = v1.18.0-up.1 UPTEST_VERSION = v1.2.0
    • Explanation: Major version updates to core dependencies could introduce compatibility issues with existing configurations. Thorough testing would be needed to ensure all functionality works with new versions.

Risk Score: 6

The score reflects moderate risk due to:

  • Major dependency version updates
  • Change in build infrastructure source
  • Complex testing logic in Makefiles
  • Automated submodule updates
    While no critical security issues are present, the breadth of infrastructure changes warrants careful review and testing.

@upbound-bot upbound-bot force-pushed the repo-sync/sa-up/default branch 2 times, most recently from 56c70c3 to f5ccfcb Compare November 28, 2024 16:07
@kaessert kaessert force-pushed the repo-sync/sa-up/default branch from 6953053 to 5e35ef7 Compare December 2, 2024 10:28
@kaessert
Copy link
Contributor

kaessert commented Dec 2, 2024

/test-examples

@upbound-bot upbound-bot force-pushed the repo-sync/sa-up/default branch from 5e35ef7 to f1c48cb Compare December 2, 2024 12:23
@kaessert
Copy link
Contributor

kaessert commented Dec 2, 2024

/test-examples

@kaessert kaessert force-pushed the repo-sync/sa-up/default branch from 54b46c1 to 5fea15e Compare December 2, 2024 16:01
@kaessert
Copy link
Contributor

kaessert commented Dec 2, 2024

/test-examples

@upbound-bot upbound-bot force-pushed the repo-sync/sa-up/default branch 2 times, most recently from 2565eb8 to ccd4fac Compare December 6, 2024 09:49
@upbound-bot upbound-bot force-pushed the repo-sync/sa-up/default branch from ccd4fac to ed223b7 Compare December 6, 2024 09:50
@kaessert
Copy link
Contributor

kaessert commented Dec 9, 2024

/test-examples

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants