Skip to content
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

Add documentation for Visual Studio build issue #2523

Merged
merged 3 commits into from
Sep 20, 2022

Conversation

josh-degraw
Copy link
Contributor

Closes #2447.

Please let me know if I could phrase anything better.


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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! I would add another sentence like "Please be careful not to include these changes when submitting a PR!"

Copy link
Contributor

@nojaf nojaf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks!

@nojaf nojaf enabled auto-merge (squash) September 20, 2022 20:09
@nojaf nojaf merged commit 11c2a86 into fsprojects:master Sep 20, 2022
@@ -5,6 +5,9 @@
### Fixed
* Wrong generic constraint placement in ML-style generic definitions with multiple type parameters. [#1868](https://github.com/fsprojects/fantomas/issues/1868)

### Documented
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documented doesn't seem to be listed on https://keepachangelog.com/en/1.0.0/
https://github.com/ionide/KeepAChangelog#changelogdata

I might remove this later.

@josh-degraw josh-degraw deleted the vs-docs branch September 21, 2022 16:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Building Fantomas in Visual Studio for dev errors
2 participants