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

Where should F# and FSharp.Core release notes live? #5489

Closed
cartermp opened this Issue Aug 10, 2018 · 9 comments

Comments

Projects
None yet
6 participants
@cartermp
Collaborator

cartermp commented Aug 10, 2018

Today, the following is done:

  • VS release notes have F# language, FSharp.Core, and tools changes listed
  • .NET CLI release notes make note of notable F# changes, but no details
  • fsharp/fslang-design has all RFCs for a given language or core library change grouped so as to be a canonical source of information about changes

Clearly, there isn't one single product or place that "owns" F#, and F# changes are cross-cutting across tools. To me, this implies that we could have a more centralized place that records F# release notes independently, then link to that from every place where F# is shipped. For example, when F# vNext is released, release notes for Ionide and Rider could link to this place once they add support for that language version.

If this were to be done, where would the release notes live? Some options:

  • This repo
  • fsharp/fsharp
  • fsharp/fslang-design
  • New repository (fsharp/releasenotes?)
  • Dedicated website, such as the fsharp.org site
  • Redundancy - list all language and core library changes in the VS release notes, .NET CLI release notes, Ionide release notes, and Rider release notes

Thoughts/suggestions?

@cartermp cartermp added the discussion label Aug 10, 2018

@jcmrva

This comment has been minimized.

Show comment
Hide comment
@jcmrva

jcmrva Aug 10, 2018

One of those repos (don't care which) and mirrored to fsharp.org (e.g. fsharp.org/release/###).

jcmrva commented Aug 10, 2018

One of those repos (don't care which) and mirrored to fsharp.org (e.g. fsharp.org/release/###).

@sergey-tihon

This comment has been minimized.

Show comment
Hide comment
@sergey-tihon

sergey-tihon Aug 10, 2018

Contributor

This repo + mirrored to fsharp.org

Contributor

sergey-tihon commented Aug 10, 2018

This repo + mirrored to fsharp.org

@purkhusid

This comment has been minimized.

Show comment
Hide comment
@purkhusid

purkhusid Aug 10, 2018

Separate F# from the VS tooling and make fsharp/fsharp the main repo for F#/F# Core and keep the release notes there ;)
Also mirror to fsharp.org

purkhusid commented Aug 10, 2018

Separate F# from the VS tooling and make fsharp/fsharp the main repo for F#/F# Core and keep the release notes there ;)
Also mirror to fsharp.org

@jackfoxy

This comment has been minimized.

Show comment
Hide comment
@jackfoxy

jackfoxy Aug 11, 2018

The most common route for me to search for release notes of any F# project is to start at the library's Nuget.org page where I can view the Version History. From there I click the Project Site link.

For most F# OSS projects this takes me to the Github page, sometimes to the github.io page. Frequently the github.io page is linked from the top description of the Github page and the documentation is in the "standard" F# docs format. I now know where the release notes link is.

SUMMARY: I would be happy with any system where I can start at Nuget.org and find the release notes with the least surprises, and least scrolling and clicking.

Release notes should always be in reverse chronological order.

jackfoxy commented Aug 11, 2018

The most common route for me to search for release notes of any F# project is to start at the library's Nuget.org page where I can view the Version History. From there I click the Project Site link.

For most F# OSS projects this takes me to the Github page, sometimes to the github.io page. Frequently the github.io page is linked from the top description of the Github page and the documentation is in the "standard" F# docs format. I now know where the release notes link is.

SUMMARY: I would be happy with any system where I can start at Nuget.org and find the release notes with the least surprises, and least scrolling and clicking.

Release notes should always be in reverse chronological order.

@isaacabraham

This comment has been minimized.

Show comment
Hide comment
@isaacabraham

isaacabraham Aug 11, 2018

Contributor

@jackfoxy that's something I thought of as well. However, FSharp.Core releases aren't in lockstep with the compiler - so there should be a page that unifies both of them i.e. compiler / language changes as well as FSharp.Core changes.

Contributor

isaacabraham commented Aug 11, 2018

@jackfoxy that's something I thought of as well. However, FSharp.Core releases aren't in lockstep with the compiler - so there should be a page that unifies both of them i.e. compiler / language changes as well as FSharp.Core changes.

@cartermp

This comment has been minimized.

Show comment
Hide comment
@cartermp

cartermp Aug 11, 2018

Collaborator

Yep, it's not straightforward:

  • Language version revs slowly
  • FSharp.Core package major/minor version revs as the language does
  • Fharp.Core package patch version revs as-needed
  • Compiler version revs whenever we insert a new compiler to VS/.NET SDK
  • VS revs at a particular cadence
  • .NET SDK revs at a particular cadence
Collaborator

cartermp commented Aug 11, 2018

Yep, it's not straightforward:

  • Language version revs slowly
  • FSharp.Core package major/minor version revs as the language does
  • Fharp.Core package patch version revs as-needed
  • Compiler version revs whenever we insert a new compiler to VS/.NET SDK
  • VS revs at a particular cadence
  • .NET SDK revs at a particular cadence
@jackfoxy

This comment has been minimized.

Show comment
Hide comment
@jackfoxy

jackfoxy Aug 11, 2018

@cartermp a common docs page linked from "The Visual F# compiler and tools".

jackfoxy commented Aug 11, 2018

@cartermp a common docs page linked from "The Visual F# compiler and tools".

@cartermp

This comment has been minimized.

Show comment
Hide comment
@cartermp

cartermp Sep 7, 2018

Collaborator

Going to start with updating the file here, represented by #5609

We'll link out from VS release notes from here (though there may be some words representing a subset in there as well, since the release notes for VS are a bit of a marketing doc).

Collaborator

cartermp commented Sep 7, 2018

Going to start with updating the file here, represented by #5609

We'll link out from VS release notes from here (though there may be some words representing a subset in there as well, since the release notes for VS are a bit of a marketing doc).

@cartermp

This comment has been minimized.

Show comment
Hide comment
@cartermp

cartermp Sep 7, 2018

Collaborator

Closing this out as the file is now more up to date: https://github.com/Microsoft/visualfsharp/blob/master/release-notes.md

In the future, you can expect more things there.

Collaborator

cartermp commented Sep 7, 2018

Closing this out as the file is now more up to date: https://github.com/Microsoft/visualfsharp/blob/master/release-notes.md

In the future, you can expect more things there.

@cartermp cartermp closed this Sep 7, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment