Add release notes

documentation/releaseNotes/README.md

@@ -0,0 +1,19 @@
+# Release Notes
+This folder contains the release notes that appear here: [https://github.com/dotnet/dotnet-monitor/releases](https://github.com/dotnet/dotnet-monitor/releases).
+
+During development, notes for current features can be added to [`releaseNotes.md`](https://github.com/dotnet/dotnet-monitor/tree/main/documentation/releaseNotes/releaseNotes.md)
+
+## File Naming
+Release notes will be named one of 3 different things based on their use:
+
+- `releaseNotes.[fullVersionNumber].md` for a released version. This is set to archive release notes from a version that has been released. `fullVersionNumber` should be the version assigned on the github release page, for example `releaseNotes.v5.0.0-preview.6.21370.3.md` would be the name of the Preview 6 release notes (if they were archived).
+- [`releaseNotes.md`](https://github.com/dotnet/dotnet-monitor/tree/main/documentation/releaseNotes/releaseNotes.md) represents release notes for the code in the current branch that hasn't been released yet.
+- [`releaseNotes.template.md`](https://github.com/dotnet/dotnet-monitor/tree/main/documentation/releaseNotes/releaseNotes.template.md) is the template to be used to create new `releaseNotes.md` in new versions.
+
+## Rotation
+These are the steps during a release describing when and how release notes should be modified:
+
+- The `main` branch will merge into `release/*.*`.
+- [`releaseNotes.md`](https://github.com/dotnet/dotnet-monitor/tree/main/documentation/releaseNotes/releaseNotes.md) (in `main`) can be overwritten by [`releaseNotes.template.md`](https://github.com/dotnet/dotnet-monitor/tree/main/documentation/releaseNotes/releaseNotes.template.md).
+- A final build should be produced from the internal official release pipeline. This will have a version like `v5.0.0-preview.6.21370.3`
+- Release notes from [`releaseNotes.md`](https://github.com/dotnet/dotnet-monitor/tree/release/5.0/documentation/releaseNotes/releaseNotes.md) (in `release/5.0` or the current release branch) should be copied into `main` as `releaseNotes.[fullVersionNumber].md` where `fullVersionNumber` is the same as the source tag that will be created during release, like `v5.0.0-preview.6.21370.3`.

documentation/releaseNotes/releaseNotes.md

@@ -0,0 +1,9 @@
+Today we are releasing the next official preview of the `dotnet-monitor` tool. This release includes:
+
+- ⚠️ A breaking change to ApiKey authentication. The `ApiAuthentication` configuration settings used in preview 6 and below will not work with preview 7 and later. We have dropped the custom authentication scheme `MonitorApiKey` and the corresponding payload format. The new ApiKey format uses the standard [`Bearer` authentication scheme](https://datatracker.ietf.org/doc/html/rfc6750.html#section-2.1) with a [JSON Web Token](https://datatracker.ietf.org/doc/html/rfc7519) payload. Use the command `dotnet monitor generatekey` to make new ApiKey credentials and the corresponding configuration. See [API Key Authentication](https://github.com/dotnet/dotnet-monitor/blob/main/documentation/authentication.md#api-key-authentication) for full details. (#247)
+- Improved detail provided in [`schema.json`](https://github.com/dotnet/dotnet-monitor/blob/main/documentation/schema.json) to more readily document configuration options. (#704)
+- Add command line option to `collect`, `--no-http-egress`, to disable HTTP egress, allowing administrator control on how data may be egressed from `dotnet monitor`. See [Disabling HTTP Egress](https://github.com/dotnet/dotnet-monitor/blob/main/documentation/egress.md#disabling-http-egress) for details. (#202)
+- The `generatekey` command has one new command line parameter, `--output`. With this parameter, the output format of the Authentication configuration may be specified to be one of: `Json`, `Text`, `Cmd`, `PowerShell` or `Shell`. See [Generating an API Key](https://github.com/dotnet/dotnet-monitor/blob/main/documentation/authentication.md#generating-an-api-key) for details. (#589)
+- ⚠️ The `generatekey` command line parameters `--hash-algorithm` and `--key-length` have been removed. (#247)
+
+\*⚠️ **_indicates a breaking change_**

documentation/releaseNotes/releaseNotes.template.md

@@ -0,0 +1,6 @@
+Today we are releasing the next official preview of the `dotnet-monitor` tool. This release includes:
+
+- ⚠️ [Here is a breaking change we did and it's work item] (#737)
+- [Here is a new feature we added and it's work item] (#737)
+
+\*⚠️ **_indicates a breaking change_**