Improve docs for paket config add-token

[daz10000]

DOcs for paket config add-token are cryptic

Spent 30 mins trying to guess what tag means, while trying to provide my nuget apikey

Repro steps

I am using paket thus
$ .paket/paket.exe push file bin/fss_postgres.1.4.0.nupkg
Paket version 3.7.3.0
Paket failed with:
Could not push package bin/fss_postgres.1.4.0.nupkg due to missing credentials for the url https://nuget.org/api/v2/package. Please specify a NuGet API key via the command line, the environment variable "nugetkey", or by using 'paket config add-token'.

Docs for add-token
https://fsprojects.github.io/Paket/commands/config.html

say you use it with TAG and TOKEN. What is the TAG? I tried nuget nugetapikey the nuget URL etc, and unclear what TAG should be.

Expected behavior

Would be nice if docs contained an example (with a fake API key) that works for nuget

[forki]

Mhm did you already figure out how to do it?
If so please help us to improve the docs by sending a pr

[daz10000]

No ;;( I ended up using the environment variable. If you can tell me what TAG should be for a nuget push I will happily supply a PR

Von meinem iPhone gesendet

Am 17.07.2016 um 23:23 schrieb Steffen Forkmann notifications@github.com:

Mhm did you already figure out how to do it?
If so please help us to improve the docs by sending a pr

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub, or mute the thread.

[forki]

/cc @JonCanning

[forki]

btw: the correct link is http://fsprojects.github.io/Paket/paket-config.html

[daz10000]

Bed time in CA but will dig more tomorrow. The projectscaffold nuget push process failed and pointed me at the config add-tag command to set my api key but the docs suggest that's more for retrieving dependencies. What does packet push use to retrieve the apikey for package publication to nuget ?

Darren

Von meinem iPhone gesendet

Am 18.07.2016 um 00:40 schrieb Steffen Forkmann notifications@github.com:

btw: the correct link is http://fsprojects.github.io/Paket/paket-config.html

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub, or mute the thread.

[JonCanning]

Tag/token is there to retrieve dependencies from private repos using a token, it shouldn't be mentioned in the error text for this scenario

Jon - that makes sense. Original error message misleading. Still fuzzy on the right way to set the apikey. As I understand it, nuget does not allow user/password auth for package push, so how do I use paket config to store the apikey? If I can understand that, I can rewrite your error message.

[daz10000]

For the record, here is the exact output from ./build.sh Release

Paket version 3.8.0.0
Paket failed with:
Could not push package C:\seq\amyris_bio\bin\Amyris.Bio.2.0.4.nupkg due to missing credentials for the url https://nuget.org/api/v2/package. Please specify a NuGet API key via the command line, the environment variable "nugetkey", or by using 'paket config add-token'.
Running build failed.

I am just reading the docs section for projectscaffold on writing a release.cmd script. If you go that route it explicitly provides the nuget key, so amybe most people don't encounter this, but I still haven't found the correct incantation to get paket to remember the apikey. Apologies for all the pain, but I'm the quintissential new test user at the moment, trying to publish a series of packages in a hurry ;(

Darren

On Mon, Jul 18, 2016 at 01:23:45AM -0700, Jon Canning wrote:

Tag/token is there to retrieve dependencies from private repos using a
token, it shouldn't be mentioned in the error text for this scenario

—
You are receiving this because you authored the thread.
Reply to this email directly, [1]view it on GitHub, or [2]mute the thread.

Reverse link: [3]unknown

References

Visible links

1. Improve docs for paket config add-token #1817 (comment)
2. https://github.com/notifications/unsubscribe-auth/AGDH9VHtrZZuDf6HQF-1FAyKYeml7xzEks5qWzgRgaJpZM4JObWo
3. Improve docs for paket config add-token #1817 (comment)

[domartynov]

Finally I figured it out :)

The push command uses the url parameter to look up the API token in paket.config.

It seems that this lookup doesn't work if the url parameter isn't specified. The url parameter plus the endpoint parameter (/api/v2/package by default) gives the final URI used to publish.

So the only solution I found is:

• use url https://www.nuget.org with the command
• add API token using: paket config add-token "https://www.nuget.org" <token>

In my build.fsx it looks like:

Paket.Push (fun p -> 
     { p with 
         PublishUrl = "https://www.nuget.org"
         WorkingDir = tempDir }) 

I.e. TAG in docs means "source" which is NuGet server URL. (TODO fix docs)
I guess this is a BUG that default url doesn't work.

[daz10000]

thanks! - I managed to get that incantation to work, with the caveat that my build.fsx didn't have the publishurl field set explicitly and I had to add that too. It looks like the default projectscaffold template doesn't do that. Might be nice to fix that. I appreciate all the time spent getting to the bottom of this, and definitely having the default behavior and docs be more explicit would help newcomes onboard. All in all though an incredible tool

[adamralph]

How can I send a PR for the docs? They seem to be auto-generated but I can't see where the source is.

[forki]

Part of that documentation comes from the internal command line parser. But additional remarks from https://github.com/fsprojects/Paket/blob/master/docs/content/commands/config.md