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

Add a warning about config in the docs for possible faliure point #8850

Merged
merged 4 commits into from
Jan 5, 2024

Conversation

annimukherjee
Copy link
Contributor

Pull Request Check List

Resolves: #4699

  • Added tests for changed code.
  • Updated documentation for changed code.

There was a mention in #4699 where in a command:

poetry config http-basic.custom-repo gitlab-ci-token ${GITLAB_JOB_TOKEN}

if ${GITLAB_JOB_TOKEN} starts with a hyphen (-) the command fails as the parser interprets it as an option being passed.

The work-around is to use:

poetry config http-basic.custom-repo -- gitlab-ci-token ${GITLAB_JOB_TOKEN}

Where the double hyphen (--) terminates the options and removes the error.

This can be extremely confusing and a warning for the same must be mentioned in the docs.
That is what I've done in the PR by changing the docs to include this warning.

docs/cli.md Outdated Show resolved Hide resolved
@radoering radoering added the impact/docs Contains or requires documentation changes label Jan 5, 2024
Copy link

github-actions bot commented Jan 5, 2024

Deploy preview for website ready!

✅ Preview
https://website-16kv6odw9-python-poetry.vercel.app

Built with commit 017aa1c.
This pull request is being automatically deployed with vercel-action

docs/cli.md Outdated Show resolved Hide resolved
@radoering radoering merged commit 24828c7 into python-poetry:master Jan 5, 2024
18 checks passed
Copy link

github-actions bot commented Mar 3, 2024

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

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 3, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
impact/docs Contains or requires documentation changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Setting credentials fails when password starts with a hyphen
2 participants