Skip to content

fix: make productLogoUrl optional - #161

Open
yuanchen8911 wants to merge 1 commit into
cncf:mainfrom
yuanchen8911:fix/optional-product-logo
Open

yuanchen8911 wants to merge 1 commit into
cncf:mainfrom
yuanchen8911:fix/optional-product-logo

Conversation

@yuanchen8911

@yuanchen8911 yuanchen8911 commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

Omitting metadata.productLogoUrl currently fails validation even though the submission instructions document it as optional with a company-logo fallback. Mark the field optional while preserving the existing checks for supplied values.

Add nine regression cases through validateProduct, covering omitted, empty, and null values; reachable and unreachable URLs under both field spellings; non-string values; and placeholders. The tests use local fixtures and stubbed HTTP responses.

Correct the productLogoUrl placeholder to [Product Logo URL, optional] in all five templates, docs/AIConformance-1.33.yaml through docs/AIConformance-1.37.yaml. This makes the templates match the documented optional field. Existing submissions are unchanged.

Closes #160.

Validation

  • Confirmed the new regression fails on the original validator for omitted, empty, and null values.
  • go test -race -v -tags validate ./scripts/...
  • go test -race -v -tags landscape ./scripts/...
  • go vet -tags validate ./scripts/...
  • Parsed all five templates as YAML and verified that only their logo placeholder changed.
  • git diff --check

Scope

The landscape generator's missing company-logo fallback is tracked separately: #162. This PR changes validator requiredness and template guidance.

The product-submission checklist is not applicable to this validator and template change.

Comment thread scripts/validate.go Resolved
@jeefy

jeefy commented Oct 29, 2026

Copy link
Copy Markdown
Member

@copilot resolve the merge conflicts in this pull request

Match validator requiredness to the documented company-logo fallback.
Add isolated regression coverage for omitted and supplied logo values.

Clarify the optional product logo placeholder in the v1.33-v1.37 templates.

Fixes cncf#160.

Signed-off-by: Yuan Chen <yuanchen97@gmail.com>
@yuanchen8911
yuanchen8911 force-pushed the fix/optional-product-logo branch 2 times, most recently from 50c04d2 to 3d7a548 Compare October 30, 2026 13:35
@yuanchen8911

Copy link
Copy Markdown
Contributor Author

resolved the conflicts

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Validator requires productLogoUrl despite documented company-logo fallback

3 participants