ossf / ossf/si-tooling

Automate adoption of v2 schema for v1 users

Open
#35 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
9
Forks
4
Avg merge
4h 3m
Merged PRs (30d)
2

Description

Desired outcome

Maintainers of a project that has previously adopted the v1 version of the schema want to easily produce a new insights file using the v2 schema based on the contents of their v1 file.

Deliverables

  • documentation explaining how to migrate from v1 to v2
  • script/tool to perform the YAML conversion
  • tests of the migration functionality

Contributor guide

No contributing guide indexed for this repository

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 v1 and v2 schema definitions, the YAML conversion script or tool, and the migration tests described in the deliverables. Verify that the documentation covers migration, the conversion produces a v2 insights file from v1 input, and the tests cover the migration functionality.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.