← Back to issue list

Add a pydantic validator for common-id

View original Github issue

Metadata

Project
snapcraft
Number
#5624
Type
issue
State
open
Author
mr-cal
Labels
Status: Triaged Type: Enhancement
Created
Updated
Closed
—

Current evaluation

Enhancement to add a pydantic validator for the common-id field (per appstream spec) to catch invalid values early. Triaged; PR #5974 targets it but is stalled with failing CI, and the validator is absent from main.

Suggested action: keep open

Reason: The issue is triaged (Status: Triaged, Type: Enhancement) and the feature is confirmed unimplemented — no field_validator for common_id exists in snapcraft/models/project.py (only autostart/command/etc. are validated). PR #5974 explicitly targets this issue but has been open 221 days with no author activity, 3 unresolved review comments, and failing CI, so the work is stalled yet the underlying request remains valid and unimplemented.

Impact: 35 Quick Win: 24.5 Staleness: 60 Complexity: 30 Confidence: 70 Support Request: 5

Issue body

### What needs to get done Add a validator for the `common-id` field based on https://www.freedesktop.org/software/appstream/docs/sect-Metadata-Application.html#tag-id-desktopapp. ### Why it needs to get done To speed up development by raising an error early, before launching a build environment.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 35
Quick Win: 24.5
Staleness: 60
Complexity: 30
Confidence: 70
Support Request: 5
keep open Enhancement to add a pydantic validator for the common-id field (per appstream spec) to catch invalid values early. Triaged; PR #5974 targets it but is stalled with failing CI, and the validator is absent from main.
qwen/qwen3.6-35b-a3b
Staleness: 35
Complexity: 40
Confidence: 85
Support Request: 0
keep open Enhancement to add a pydantic validator for the common-id field to catch errors early. Issue is triaged, assigned to a contributor, and currently under development.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 20
Confidence: 80
Support Request: 0
keep open Enhancement to add a pydantic validator for the common-id field based on freedesktop specs. Triaged and assigned, but inactive for nearly a year.
qwen3.6-35b-a3b-mtp-q6
Staleness: 80
Complexity: 20
Confidence: 75
Support Request: 5
keep open Implement a pydantic validator for the common-id field to catch metadata errors early in development. Status is triaged and currently awaiting assignment after a contributor volunteered to take it on.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: canonical/snapcraft#5974 (confidence 55%)

    PR titled 'feat(project): add pydantic validator for common_id field' states it fixes this issue, but is stalled (221 days, no author activity, failing integration/OSV-scanner CI) and the validator is absent from current main.

Related issues

Issue Project State Summary Similarity
#5974 feat(project): add pydantic validator for common_id field snapcraft open Adds a pydantic validator for the app common_id field to catch invalid values early, fixing #5624. Open 221 days with no author activity, 3 unresolved review comments, and failing integration/OSV-scanner CI; the validator is absent from current main.
82%
#5625 feat(project): add pydantic validator for common_id field snapcraft closed Closed without merging due to failing CI checks and unresolved review comments. Added a pydantic validator for the common_id field but did not resolve integration test failures or linting issues.
72%