-
Notifications
You must be signed in to change notification settings - Fork 588
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
Update documentation following "bug" 2486 #2520
Conversation
help/markdown/fake-template.md
Outdated
- `tool` - Installs the FAKE dotnet sdk global tool into the `--tool-path` folder | ||
- `none` - Does not bootstrap FAKE. Use this if you want to use a global installation of FAKE | ||
|
||
### --dependencies | ||
Specifies your prefered way to define the nuget packages used in your build: | ||
Specifies your preferred way to define the nuget packages used in your build: | ||
|
||
- `file` (default) - Creates a `paket.dependencies` file to define build dependencies | ||
- `inline` - Defines build dependencies inside the build script |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The issue was quite a while ago but in addition to your change above inline
should have (default)
now, correct?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes you are right. I'll update when I can. I am new to making contribution on Github though. So question is how do I proceed with updating the documentation following your comment? Can I somehow update this pull pull request?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can I somehow update this pull pull request?
Indeed, just commit and push to your branch, it will be updated automatically.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Apologies for being pedantic or maybe it's my lack of understanding but for this line
inline
- Defines build dependencies inside the build script
which is now the default, the description, "Defines build dependencies inside the build script", is a bit unclear to me.
Do you mean that in our build script e.g. build.fsx,
we would have to do something like:
#r "paket:
nuget Fake.DotNet.Cli
nuget Fake.IO.FileSystem
nuget Fake.Core.Target
nuget FSharp.Data //"
If so, I think including it in the documentation might be useful because I'm not familiar with this construct.
From my understanding this is a FAKE specific construct because if I try to send this to FSI, I'll get something like
error FS3216: Package manager key 'paket' was not registered in [/usr/share/dotnet/sdk/3.1.201/FSharp; /usr/share/dotnet/sdk/3.1.201/FSharp/], []. Currently registered: nuget
Thanks for taking care of that! |
'inline' is now the default option for '--depedencies'
#2486
Description
This is a documentation update about fake templates following #2486.
There are also typo and grammatical corrections
dotnet new fake
does not create paket.dependencies #2486