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

Add release-specific release.json files #9427

Closed
wants to merge 21 commits into from
Closed

Conversation

richlander
Copy link
Member

@richlander richlander commented Jul 23, 2024

Fixes #9417.

Improvements:

  • Add READMEs for new content
  • Generate releases-index.json
  • Generate patch-releases-index.json, per release
  • Generate release.json, per patch release
  • Update releases.json, per major release, to include all the required information for generating the other files
  • Generate/add schemas for all JSON formats
  • Add $schema reference to JSON files

Notes:

  • I only generated the fancy new files for releases in-support. That had the benefit of making it so that the algorithm doesn't continue to re-generate these files for releases no longer generating new content.
  • I didn't add a schema reference to the generated files, both because it doesn't seem necessary (no edits are intended) and I do not know how.
  • I'll add os-packages.json files for .NET 6 and 8 in a later PR.

@Falco20019 @martincostello @leecow

release-notes/9.0/patch-release-index.json Outdated Show resolved Hide resolved
release-notes/9.0/patch-release-index.json Outdated Show resolved Hide resolved
release-notes/formats.md Outdated Show resolved Hide resolved
release-notes/formats.md Outdated Show resolved Hide resolved
release-notes/schemas/dotnet-patch-releases-index.json Outdated Show resolved Hide resolved
release-notes/schemas/dotnet-patch-releases-index.json Outdated Show resolved Hide resolved
release-notes/schemas/dotnet-patch-releases-index.json Outdated Show resolved Hide resolved
release-notes/schemas/dotnet-patch-release.json Outdated Show resolved Hide resolved
richlander and others added 2 commits July 24, 2024 07:25
Co-authored-by: Martin Costello <martin@martincostello.com>
@richlander
Copy link
Member Author

richlander commented Jul 25, 2024

I think I got all of that @martincostello. Thanks much!

The formats file still needs some help.

I'll make another PR to update the link forwards in release-index.json in another PR.

@richlander richlander marked this pull request as ready for review July 30, 2024 03:27
@richlander
Copy link
Member Author

I believe that this PR is ready to go.

Much of this is based on an OM I built, which is the basis of the schema generation and the serializer for release.json. I did a test where I deserialized and then serialized releases.json and then used a json diff tool to see how before and after compared. The test passed. I also validated the files with these new schema. That also seems to pass (you can test this yourself).

We need to wait for @leecow to validate the following changes:

  • Updates to releases-index.json and releases.json files
  • Addition of patch-releases-index.json and release.json files

These all need to be uploaded/updated in blob storage before merging.

We should also double check that everyone is good with the new property and file names.

Copy link
Contributor

@Falco20019 Falco20019 left a comment

Choose a reason for hiding this comment

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

See some comments on richlander/distroessed#5 (review) for changes to the generated schemas. Usually, schemas also do set "additionalProperties": false to make it clear that there are no additional fields allowed in the JSON. Not fully required, but would make intention more clear.

Copy link
Contributor

Choose a reason for hiding this comment

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

Add the $schema.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm not sure if System.Text.Json supports those things.

@eiriktsarpalis

Copy link
Member

Choose a reason for hiding this comment

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

By default STJ allows additional properties which is reflected in the generated schema. This setting can be overridden using the JsonUnmappedMemberHandlingAttribute.

Copy link
Member Author

Choose a reason for hiding this comment

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

I made this update.

e868532

DimucaTheDev and others added 4 commits July 30, 2024 13:14
Removed semicolon after property declaration
* os-packages.json: Add FreeBSD section

* Change order of OS families

* Update markdown

---------

Co-authored-by: Gleb Popov <6yearold@gmail.com>
@richlander
Copy link
Member Author

I had to do process a merge conflict due to #9424. I knew that would happen, but that's how it goes.

@richlander
Copy link
Member Author

This work will be broken into multiple PRs.

@richlander richlander closed this Aug 22, 2024
@richlander richlander deleted the patch-release-index branch December 17, 2024 18:43
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.

Create release.json files per patch release
9 participants