Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ Improve JSON format #934

Merged
merged 9 commits into from
Sep 1, 2021
Merged

Conversation

laurentsimon
Copy link
Contributor

  • Please check if the PR fulfills these requirements
  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
    feature

  • What is the current behavior? (You can also link to an open issue here)
    lack of info in JSON format

  • What is the new behavior (if this is a feature change)?

  1. JSON format uses lower-case letter for fields (OSV, GitHub API, etc all use lowercase fields)
  2. Add scorecard's hash and version to JSON
  3. Retrieve version/hash information automatically
  4. Move build info under pkg/
  • Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
    no

  • Other information:

Copy link
Contributor

@azeemshaikh38 azeemshaikh38 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we decouple logic for cron job JSON from Scorecard JSON before this PR?

@laurentsimon
Copy link
Contributor Author

Can we decouple logic for cron job JSON from Scorecard JSON before this PR?

I'll start working on it. Are there unit tests needs for the cron job/JSON? I don't see any. I think I'll add JSON unit tests/schema validator as I did for the scorecard JSON format. Sounds good?

@azeemshaikh38
Copy link
Contributor

Can we decouple logic for cron job JSON from Scorecard JSON before this PR?

I'll start working on it. Are there unit tests needs for the cron job/JSON? I don't see any. I think I'll add JSON unit tests/schema validator as I did for the scorecard JSON format. Sounds good?

SGTM

@laurentsimon
Copy link
Contributor Author

Can we decouple logic for cron job JSON from Scorecard JSON before this PR?

I'll start working on it. Are there unit tests needs for the cron job/JSON? I don't see any. I think I'll add JSON unit tests/schema validator as I did for the scorecard JSON format. Sounds good?

done with #941

@laurentsimon laurentsimon enabled auto-merge (squash) August 31, 2021 22:54
@laurentsimon laurentsimon merged commit 8f5e742 into ossf:main Sep 1, 2021
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.

2 participants