Release notes proposal

.github/workflows/check_release_notes.yml

@@ -50,45 +50,11 @@ jobs:
 
         echo "Opt out of release notes: $OPT_OUT_RELEASE_NOTES"
 
-        # Parse version from eng/Versions.props
-        # For FSarp.Core:
-        # <FSMajorVersion>8</FSMajorVersion>
-        # <FSMinorVersion>0</FSMinorVersion>
-        # <FSBuildVersion>100</FSBuildVersion>
-        # For FCS:
-        # FCSMajorVersion>43</FCSMajorVersion>
-        # <FCSMinorVersion>8</FCSMinorVersion>
-        # <FCSBuildVersion>$(FSBuildVersion)</FCSBuildVersion>
-        # For VS:
-        # <VSMajorVersion>17</VSMajorVersion>
-        # <VSMinorVersion>8</VSMinorVersion>
-
-        _fs_major_version=$(grep -oPm1 "(?<=<FSMajorVersion>)[^<]+" eng/Versions.props)
-        _fs_minor_version=$(grep -oPm1 "(?<=<FSMinorVersion>)[^<]+" eng/Versions.props)
-        _fs_build_version=$(grep -oPm1 "(?<=<FSBuildVersion>)[^<]+" eng/Versions.props)
-        _fcs_major_version=$(grep -oPm1 "(?<=<FCSMajorVersion>)[^<]+" eng/Versions.props)
-        _fcs_minor_version=$(grep -oPm1 "(?<=<FCSMinorVersion>)[^<]+" eng/Versions.props)
-        _fcs_build_version=$_fs_build_version
-        _vs_major_version=$(grep -oPm1 "(?<=<VSMajorVersion>)[^<]+" eng/Versions.props)
-        _vs_minor_version=$(grep -oPm1 "(?<=<VSMinorVersion>)[^<]+" eng/Versions.props)
-
-        FSHARP_CORE_VERSION="$_fs_major_version.$_fs_minor_version.$_fs_build_version"
-        FCS_VERSION="$_fcs_major_version.$_fcs_minor_version.$_fcs_build_version"
-        VISUAL_STUDIO_VERSION="$_vs_major_version.$_vs_minor_version"
-
-        echo "Found F# version: ${FSHARP_CORE_VERSION}"
-        echo "Found FCS version: ${FCS_VERSION}"
-        echo "Found Visual Studio version: ${VISUAL_STUDIO_VERSION}"
-
-        [[ "$FSHARP_CORE_VERSION" =~ ^[0-9]+\.[0-9]+.[0-9]+$ ]] || (echo "  Invalid FSharp.Core Version parsed"; exit 1)
-        [[ "$FCS_VERSION" =~ ^[0-9]+\.[0-9]+.[0-9]+$ ]] || (echo "  Invalid FCS Version parsed"; exit 1)
-        [[ "$VISUAL_STUDIO_VERSION" =~ ^[0-9]+\.[0-9]+$ ]] || (echo "   Invalid Visual Studio Version parsed"; exit 1)
-
         _release_notes_base_path='docs/release-notes'
-        _fsharp_core_release_notes_path="${_release_notes_base_path}/FSharp.Core/${FSHARP_CORE_VERSION}.md"
-        _fsharp_compiler_release_notes_path="${_release_notes_base_path}/FSharp.Compiler.Service/${FSHARP_CORE_VERSION}.md"
-        _fsharp_language_release_notes_path="${_release_notes_base_path}/Language/preview.md"
-        _fsharp_vs_release_notes_path="${_release_notes_base_path}/VisualStudio/${VISUAL_STUDIO_VERSION}.md"
+        _fsharp_core_release_notes_path="${_release_notes_base_path}/FSharp.Core.md"
+        _fsharp_compiler_release_notes_path="${_release_notes_base_path}/FSharp.Compiler.Service.md"
+        _fsharp_language_release_notes_path="${_release_notes_base_path}/Language.md"
+        _fsharp_vs_release_notes_path="${_release_notes_base_path}/VisualStudio.md"
 
         readonly paths=(
             "src/FSharp.Core|${_fsharp_core_release_notes_path}"

docs/content/fsdocs-theme.css

@@ -0,0 +1,3 @@
+:root {
+    --main-menu-width: 300px;
+}

docs/release-notes/About.md

@@ -0,0 +1,30 @@
+---
+category: Release Notes
+categoryindex: 600
+index: 1
+title: About
+---
+
+# About
+
+The release notes for the [F\# language](./Language.md), [FSharp.Core](./FSharp.Core.md) and [FSharp.Compiler.Service](./FSharp.Compiler.Service.md) are based on the [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format.  
+The target audience these release notes are the respective end-users.
+
+## Writing a changelog entry
+
+In order to keep the change logs consistent the following format was proposed for each entry:
+
+```md
+* <Informative description>. ([PR #16106](https://github.com/dotnet/fsharp/pull/16106))
+```
+
+Some tips:
+
+* Use valid [Markdown](https://www.markdownguide.org/).
+* Use `*` as bullet point symbol. We don't want to mix `*` and `-`.
+* Start your description with a capital and end the sentence with a dot.
+* **Always** include a link to your pull request before the closing `)`, `([PR #16106](https://github.com/dotnet/fsharp/pull/16106))`.
+* If possible, include a link to an issue on `dotnet/fsharp` use `[Issue #16359](https://github.com/dotnet/fsharp/issues/16359)` before the link to the pull request.
+* If possible, include a link to a language suggestion from  `dotnet/fsharp` use `[Language suggestion #721](https://github.com/fsharp/fslang-suggestions/issues/721)` before the link to the pull request.
+* Choose the right section for your type of change. (`## Added`, `## Changed`, `## Deprecated`, `## Removed`, `## Fixed` or `## Security`).
+* Ensure you description makes it clear what the change is about. The reader should be informed on a high level without needing to click through the pull request link and find out in the code what actually changed.

docs/release-notes/FSharp.Compiler.Service.md

@@ -0,0 +1,21 @@
+---
+category: Release Notes
+categoryindex: 600
+index: 4
+title: FSharp.Compiler.Service
+---
+
+# FSharp.Compiler.Service
+
+## Unreleased
+
+### Fixes
+
+* Miscellaneous fixes to parentheses analysis. ([PR #16262](https://github.com/dotnet/fsharp/pull/16262))
+* Correctly handle assembly imports with public key token of 0 length. ([Issue #16359](https://github.com/dotnet/fsharp/issues/16359), [PR #16363](https://github.com/dotnet/fsharp/pull/16363))
+
+## 43.8.100 - 2023-11-14
+
+### Fixed
+
+* Include the `get,set` keywords in the range of `SynMemberDefn.AutoProperty`. ([PR #15835](https://github.com/dotnet/fsharp/pull/15835))

docs/release-notes/FSharp.Core.md

@@ -0,0 +1,19 @@
+---
+category: Release Notes
+categoryindex: 600
+index: 3
+title: FSharp.Core
+---
+
+# FSharp.Core
+
+## Unreleased
+
+### Added
+
+* More inlines for Result module. ([PR #16106](https://github.com/dotnet/fsharp/pull/16106))
+
+## 8.0.100 - 2023-11-14
+
+### Added
+* `TailCallAttribute` ([Language suggestion #721](https://github.com/fsharp/fslang-suggestions/issues/721), [PR #15503](https://github.com/dotnet/fsharp/pull/15503))

docs/release-notes/Language.md

@@ -0,0 +1,21 @@
+---
+category: Release Notes
+categoryindex: 600
+index: 2
+title: F# Language
+---
+
+# F\# Language
+
+## Unreleased
+
+### Added
+
+* Better generic unmanaged structs handling. ([Language suggestion #692](https://github.com/fsharp/fslang-suggestions/issues/692), [PR #12154](https://github.com/dotnet/fsharp/pull/12154))
+* Bidirectional F#/C# interop for 'unmanaged' constraint. ([PR #12154](https://github.com/dotnet/fsharp/pull/12154))
+
+## 8.0.0 - 2023-11-14
+
+### Added
+
+* `while!` ([Language suggestion #1038](https://github.com/fsharp/fslang-suggestions/issues/1038), [PR #14238](https://github.com/dotnet/fsharp/pull/14238))