ossf / ossf/package-analysis

Check for package-feeds pubsub `SchemaVer` field in Scheduler

Open
#48 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Go
Stars
912
Forks
74
PR merge metrics
No merged PRs in 30d

Description

The package-feeds project now validates & versions its package data output against a json schema https://github.com/ossf/package-feeds/blob/main/package.schema.json

The SchemaVer should follow semantic versioning, as such any minor 1.* release should guarantee compatibility for the current Scheduler expectations (Name, Version, Type). Any major version bump could signal incompatability (see https://github.com/ossf/package-feeds/issues/93 for example) as such this value should be checked before blindly accessing the current fields

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Scheduler code that consumes package-feeds output and inspect how SchemaVer and the current Name, Version, and Type fields are read. Review package.schema.json and the linked package-feeds issue for the compatibility context. Done means the Scheduler checks SchemaVer before accessing fields and handles an incompatible major version safely.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
backend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.