Skip to content

Add release-specific release.json files #9427

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

Closed
wants to merge 21 commits into from
Closed
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions release-notes/9.0/patch-releases-index.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{
"channel-version": "9.0",
"latest-release": "9.0.0-preview.6",
"latest-release-date": "2024-07-09",
"releases": [
{
"release-version": "9.0.0-preview.6",
"release-date": "2024-07-09",
"security": false,
"release-info-uri": "https://dotnetcli.blob.core.windows.net/dotnet/release-metadata//9.0/preview/preview6/release.json"
},
{
"release-version": "9.0.0-preview.5",
"release-date": "2024-06-11",
"security": false,
"release-info-uri": "https://dotnetcli.blob.core.windows.net/dotnet/release-metadata//9.0/preview/preview5/release.json"
},
{
"release-version": "9.0.0-preview.4",
"release-date": "2024-05-21",
"security": false,
"release-info-uri": "https://dotnetcli.blob.core.windows.net/dotnet/release-metadata//9.0/preview/preview4/release.json"
},
{
"release-version": "9.0.0-preview.3",
"release-date": "2024-04-11",
"security": false,
"release-info-uri": "https://dotnetcli.blob.core.windows.net/dotnet/release-metadata//9.0/preview/preview3/release.json"
},
{
"release-version": "9.0.0-preview.2",
"release-date": "2024-03-12",
"security": false,
"release-info-uri": "https://dotnetcli.blob.core.windows.net/dotnet/release-metadata//9.0/preview/preview2/release.json"
},
{
"release-version": "9.0.0-preview.1",
"release-date": "2024-02-13",
"security": false,
"release-info-uri": "https://dotnetcli.blob.core.windows.net/dotnet/release-metadata//9.0/preview/preview1/release.json"
}
]
}
499 changes: 499 additions & 0 deletions release-notes/9.0/preview/preview1/release.json

Large diffs are not rendered by default.

499 changes: 499 additions & 0 deletions release-notes/9.0/preview/preview2/release.json

Large diffs are not rendered by default.

499 changes: 499 additions & 0 deletions release-notes/9.0/preview/preview3/release.json

Large diffs are not rendered by default.

505 changes: 505 additions & 0 deletions release-notes/9.0/preview/preview4/release.json

Large diffs are not rendered by default.

505 changes: 505 additions & 0 deletions release-notes/9.0/preview/preview5/release.json

Large diffs are not rendered by default.

505 changes: 505 additions & 0 deletions release-notes/9.0/preview/preview6/release.json

Large diffs are not rendered by default.

44 changes: 28 additions & 16 deletions release-notes/formats.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,47 @@
# Release note formats

Release notes are available in a combination of markdown and JSON formats. The intent is to make all release notes available in markdown and also in JSON if there is a scenario that requires structured data. This content is [licensed](./license-information.md) for broad use.
Release notes are available in a combination of markdown and JSON formats. The intent is to make release notes available in JSON format if there is a scenario that requires structured data. This content is [licensed](./license-information.md) for broad use.

Our approach has evolved over time. The following descriptions are for our latest practices.
JSON schemas are available for JSON formats at [schemas](./schemas/README.md).

## Monthly patch release notes (markdown)
## Monthly patch release notes

We typically release an update each month. These often include security fixes for vulnerabilities (AKA CVEs) disclosed on the same day.
We typically release updates each month. These often include security fixes for vulnerabilities (AKA CVEs) disclosed on the same day. We publish release notes that provide extensive information about the release.

Examples:

- [6.0.32](./6.0/6.0.32/6.0.32.md)
- [8.0.1](./8.0/8.0.1/8.0.1.md)

These markdown files include the following information:
Typical information:

- Links to binaries
- Notable changes, including CVEs
- Compatibility information
- Updates packages

## Monthly preview release notes (markdown)
Examples markdown files:

- [6.0/6.0.32/6.0.32.md](./6.0/6.0.32/6.0.32.md)
- [8.0/8.0.1/8.0.1.md](./8.0/8.0.1/8.0.1.md)

Example JSON files:

- [releases-index.json](./releases-index.json)
- [9.0/releases.json](./9.0/releases.json)
- [9.0/patch-release-index.json](./9.0/patch-release-index.json)
- [Patch release overview](./9.0/preview/preview1/release.json)

We typically release a preview for the next major version each month. These are much the same as the monthly patches; however, they will not include CVE information until the new major release is supported (starting with RC1).
## Monthly preview release notes

We typically release a preview for the next major version each month. These are much the same as the monthly patches.

They primarily differ in two ways:

- Dense feature descriptions
- No CVE information (applies to previews, not RCs)

Examples:

- [.NET 9 Preview 1](./9.0/preview/preview1/README.md)
- [.NET 9 Preview 6](./9.0/preview/preview6/README.md)

These markdown files are primarily composed of dense feature descriptions. This content is used as source material for [What's New](https://learn.microsoft.com/dotnet/core/whats-new/dotnet-9/overview) pages in official Microsoft docs, which are [often updated](https://github.com/dotnet/docs/pulls?q=is%3Apr+What%27s+New) on the same day as a preview release.
This content is used as source material for [What's New](https://learn.microsoft.com/dotnet/core/whats-new/dotnet-9/overview) pages in official Microsoft docs, which are [often updated](https://github.com/dotnet/docs/pulls?q=is%3Apr+What%27s+New) on the same day as a preview release.

Preview release notes are always in a `preview` folder. This approach was adopted so that preview releases do not distract from stable releases once preview releases are no longer relevant.

Expand Down Expand Up @@ -89,11 +101,11 @@ Examples:

## OS packages (json and markdown)

OS package information is published for each release. This information indicates which packages must be installed on a given distro for a .NET app (or the .NET SDK) to run. [.NET packages](../linux.md) are available for multiple distros, which automatically install all required packages
OS package information is published for each release. This information indicates which packages must be installed on a given distro for a .NET app (or the .NET SDK) to run. [.NET packages](../linux.md) are available for multiple distros, which automatically install all required packages.

Schema: [dotnet-os-packages.json](./schemas/dotnet-os-packages.json)

Examples:

- [.NET 9 OS packages (json)](./9.0/os-packages.json)
- [.NET 9 OS packages (markdown)](./9.0/os-packages.md)

Schema: [dotnet-requires-packages](./schemas/dotnet-os-packages.json)
3 changes: 3 additions & 0 deletions release-notes/schemas/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Release notes schemas

Information here.
2 changes: 1 addition & 1 deletion release-notes/schemas/dotnet-os-packages.json
Original file line number Diff line number Diff line change
Expand Up @@ -189,4 +189,4 @@
"packages",
"distributions"
]
}
}
Loading
Loading