From 6f8fdfa0d8b1a979b3eb1cafd3c223c58463972e Mon Sep 17 00:00:00 2001 From: Josh DeGraw Date: Tue, 20 Sep 2022 10:56:47 -0600 Subject: [PATCH 1/2] Add documentation for Visual Studio build issue --- CHANGELOG.md | 5 +++++ docs/docs/contributors/Index.md | 6 ++++++ 2 files changed, 11 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index f914a986b7..1e10971323 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,10 @@ # Changelog +## Unreleased + +### Documented +* Building Fantomas in Visual Studio for dev errors. [#2447](https://github.com/fsprojects/fantomas/issues/2447) + ## [5.0.1] - 2022-09-18 ### Fixed diff --git a/docs/docs/contributors/Index.md b/docs/docs/contributors/Index.md index d42b1fed86..44155ba01f 100644 --- a/docs/docs/contributors/Index.md +++ b/docs/docs/contributors/Index.md @@ -21,4 +21,10 @@ The best is yet to come! PS: Don't hesitate to open [an issue](https://github.com/fsprojects/fantomas/issues/new/choose) if you have any questions. Or if something isn't all that clear. Our goal is to make this documentation as complete as possible🎉! +## Visual Studio Issue + +There is currently [a known issue](https://github.com/fsprojects/fantomas/issues/2447) when loading the `fantomas` solution in Visual Studio that prevents the solution from being able to build properly. This is due to an issue in the `Ionide.KeepAChangelog` build step (tracking the issue [here](https://github.com/ionide/KeepAChangelog/issues/8)). + +To workaround this in the meantime, you'll need to comment out the references to `Ionide.KeepAChangelog.Tasks` in `paket.dependencies` and all of the `paket.references` files, and then run `dotnet paket install` again. + From a4444db00ca3a5528dd2e03d6fb31b860ad16b40 Mon Sep 17 00:00:00 2001 From: Josh DeGraw Date: Tue, 20 Sep 2022 14:01:41 -0600 Subject: [PATCH 2/2] Add additional comment to VS issue doc --- docs/docs/contributors/Index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/contributors/Index.md b/docs/docs/contributors/Index.md index 44155ba01f..950eaf6805 100644 --- a/docs/docs/contributors/Index.md +++ b/docs/docs/contributors/Index.md @@ -25,6 +25,6 @@ Or if something isn't all that clear. Our goal is to make this documentation as There is currently [a known issue](https://github.com/fsprojects/fantomas/issues/2447) when loading the `fantomas` solution in Visual Studio that prevents the solution from being able to build properly. This is due to an issue in the `Ionide.KeepAChangelog` build step (tracking the issue [here](https://github.com/ionide/KeepAChangelog/issues/8)). -To workaround this in the meantime, you'll need to comment out the references to `Ionide.KeepAChangelog.Tasks` in `paket.dependencies` and all of the `paket.references` files, and then run `dotnet paket install` again. +To workaround this in the meantime, you'll need to comment out the references to `Ionide.KeepAChangelog.Tasks` in `paket.dependencies` and all of the `paket.references` files, and then run `dotnet paket install` again. **Please be careful not to include these changes when submitting a PR!**