docker / docker/cli

chore: consider switching JSON-schema dependency to github.com/santhosh-tekuri/jsonschema

Open
#5,884 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area/dependencies help wanted kind/refactor
Dominant language
Go
Stars
6.1k
Forks
2.2k
Avg merge
1d 15h
Merged PRs (30d)
43

Description

Description

The github.com/xeipuuv/gojsonschema module used for JSON-schema validation has not been maintained for a long time, and because of that, ended on the "avoid" list in kubernetes; https://github.com/kubernetes/kubernetes/issues/128572#issuecomment-2457145817

The OCI image-spec has now transitioned to a new dependency (github.com/santhosh-tekuri/jsonschema) as replacement in v1.1.1, and we should look if we can follow so that we don't end up with two separate dependencies performing the same task;

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 Docker CLI's use of github.com/xeipuuv/gojsonschema and reviewing the related compose-go issue. Compare the proposed replacement with the OCI image-spec migration and check whether validation behavior remains compatible. Done means reaching a documented dependency decision and identifying the required scope of any migration.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.