search

fsprojects / FSharpLint

Lint tool for F#
https://fsprojects.github.io/FSharpLint/
MIT License
303 stars 73 forks source link

[RFC] Use 'Packages' storage for the docs when doing a paket restore #615

Closed Numpsy closed 10 months ago

Numpsy commented 10 months ago

I've been trying to get everything building with .NET 6 and the related tooling, and have been getting CI build failures in the macOS builds, with errors that look like those described at https://github.com/fsprojects/Paket/issues/3767

It looks like changing Paket to use 'packages' storage instead of 'symlink' avoids that issue, by putting the restored nuget packages directly into the local packages folder instead of symlinking them. (I don't know much about this Paket feature - the docs suggest its for reducing disk usage by avoid duplicates, which might not really be an issue for the builds?)

On a related note, we also have this issue - https://github.com/fsprojects/FSharpLint/issues/578 - where you have to either run the build as admin on windows or set some extra OS options otherwise the package restore will fail. I think this change would avoid that as well.

Note: Changing the paket storage to 'none' helped with package restore issue, but caused the 'docs' build to break for me because the Fornax tool couldn't find the libraries, whereas it works when set to 'packages'

knocte commented 10 months ago

LGTM! Just a nit: can you add your precious PR description text into the commit msg? No reason for them to be different :) (This way, if we move out of github in the future, people would be able to still find the why for your commit just by using git blame ;) )

Numpsy commented 10 months ago

updated

knocte commented 10 months ago

Why did you remove the commit msg title? It's always good to separate the title from the commit msg body by 1 blank line, like if the first line was the subject of an email and the rest the email. And in this case you can just use PR title as commit msg title, and PR description as commit msg body.