Setting credentials fails when password starts with a hyphen

[twoolie]

• I am on the latest Poetry version.

• I have searched the issues of this repo and believe that this is not a duplicate.

• If an exception occurs when executing a command, I executed it again in debug mode (-vvv option).

• OS version and name: NixOS 21.05

• Poetry version: 1.1.11

Issue

When setting repository credentials with poetry config http-basic.custom-repo gitlab-ci-token ${GITLAB_JOB_TOKEN} the command will fail any time the GITLAB_JOB_TOKEN begins with a hyphen. The command line parser tries to treat the password as an option.

The current workaround is to use double hyphen e.g. poetry config http-basic.custom-repo -- gitlab-ci-token ${GITLAB_JOB_TOKEN}

This should either be fixed in the option parser, or the workaround documented in the manual.

[paketb0te]

We ran into the same issue due to the ${GITLAB_JOB_TOKEN} (which is generated by GitLab dynamically) sometimes starting with a dash - and thus, poetry interpreting the next character as an option, which it then obviously can't find.

@twoolie how did you find the workaround using -- ? It works in our case as well, just curious to understand the mechanics behind it.

[dimbleby]

this is just regular behaviour for command line programs. eg try to grep for a string that begins with a hyphen: it'll try to interpret it as an option.

See also #4853.

Nothing to do here.

[neersighted]

Agreed, this is standard behavior of CLI applications, and there is no need for a workaround as the proper solution (-- to terminate options parsing in the Unix tradition) is available. I'm leaving this open as this seems like an excellent FAQ candidate.

[clintonroy]

we could modify the input maybe, poetry config key==--value would get around it.

[neersighted]

I'm personally not enthused about adding some custom tokenization/splitting when what we have works fine and is stable, especially as certain usernames with whatever token we choose would become impossible to express.

[twoolie]

@paketb0te the workaround works well. I feel that it's a good enough solution. I think that it should be documented and that the examples in the docs should always use -- so that people don't get caught out when try to do this in their CI scripts. Admittedly this is less critical for me personally since gitlab started prefixing their tokens.

[paketb0te]

@twoolie yeah it works great, I just was not aware that this exists (using double hyphen to stop parsing options) 😄

I agree there is nothing to fix here, except maybe adding a hint in the docs / FAQ.

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.