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

#461 Changed build script to use fake instead of fsi for docs generation #474

Merged
merged 2 commits into from
Oct 21, 2019

Conversation

vbop9834
Copy link
Collaborator

Thank you to the wonderful people of F# for leaving a bread crumb trail

fsprojects/ProjectScaffold@6e4a6b6#diff-2efaaa9f2632e3258cdcbc80f78883eaR186

fsprojects/FAKE#1092

@vbop9834
Copy link
Collaborator Author

@lefthandedgoat It was ignoring the exit code before. Do we want to continue ignoring the exit code of the script?

@vbop9834
Copy link
Collaborator Author

Not ready yet. found a bug. Investigating

@vbop9834
Copy link
Collaborator Author

A big future project:

Migrate FAKE scripts to FAKE 5 (fully support Dotnet core)

https://fake.build/fake-migrate-to-fake-5.html

Potential Obstacles

Pros

  • Reduce dependencies and group them
  • Added FAKE functions that simplify the code
  • Fake integration with dotnet CLI

Ideas

  • Integrate canopy into the dotnet cli test runner

@vbop9834
Copy link
Collaborator Author

Current Issues

  • " Could not read comments from entity 'canopy.reporters.LiveHtmlReporter': System.InvalidOperationException: The entity or value 'System.Exception' does not exist or is in an unresolved assembly. You may need to add a reference to assembly 'netstandard'"
  • "Could not read comments from entity 'classic': Microsoft.FSharp.Compiler.ErrorLogger+UnresolvedPathReferenceNoRange: Exception of type 'Microsoft.FSharp.Compiler.ErrorLogger+UnresolvedPathReferenceNoRange' was thrown."
  • "FSharp.Formatting Error: 0 : Error while building member-name for canopy.types.Test because: not a named type"
  • "Could not read comments from entity 'canopy.csharp.canopy': System.InvalidOperationException: The entity or value 'OpenQA.Selenium.By' does not exist or is in an unresolved assembly. You may need to add a reference to assembly 'WebDriver'"

@thinkbeforecoding
Copy link

@JeremyBellows in FSharp.Text.RegexProvider I updated the doc generation to not use Razor, but Fable.React server side rendering...

@lefthandedgoat lefthandedgoat merged commit d68ca55 into lefthandedgoat:master Oct 21, 2019
@lefthandedgoat
Copy link
Owner

Thanks a mil Jeremy!

@vbop9834 vbop9834 deleted the 461-DocGenFix branch October 21, 2019 15:12
@lefthandedgoat
Copy link
Owner

Jeremy if you have the willpower to look into this, errors were thrown during the reference generation and it looks like some pages are not there (classic, parallell, and instanced looks broke)

http://lefthandedgoat.github.io/canopy/reference/index.html

Also, all the paths on the right hand list of links like Actions etc, are pointed at c://my/path/to/canopy

http://lefthandedgoat.github.io/canopy/index.html

@vbop9834
Copy link
Collaborator Author

I think it's time to start the big project mentioned above.

We need to migrate FAKE to FAKE 5.0

Much thanks to @thinkbeforecoding for removing Razor! That was a huge obstacle.

@lefthandedgoat If we follow the migration docs in order then it will hopefully be not as painful.

Another option is recreating canopy with a blank dotnet core template. I'm not confident yet that this is a less painful route.

What do you want to do?

@lefthandedgoat
Copy link
Owner

@JeremyBellows Fake 5 is fine with me. If we remove the two deprecated Nuget targes, the script is less than 200 lines long which seems manageable?

@lefthandedgoat
Copy link
Owner

@JeremyBellows I have updated to Fake5 except for what I think are a few new helpers you added earlier.

https://github.com/lefthandedgoat/canopy/tree/484-fix-documentation

Does that put it in a good place for you?

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.

3 participants