sourcery icon indicating copy to clipboard operation
sourcery copied to clipboard

Published 20 hours ago • verified publisher icon sourcery-ai

Documentation regarding `auth.yaml` file

Open Uzaaft opened this issue 3 years ago • 3 comments

Issue description or question

I have observed that sourcery creates an auth.yaml file in the ~/.config/sourcery/ directory, but it has not been documented in the docs. Could you guys implement it, so that LSP developers knows the expected behaviour of sourcery on all platforms?

Sourcery Version

version 0.9.8

Code editor or IDE name and version

NVIM v0.7.0-dev+921-g1907a9481

OS name and version

I've tested the auth.yaml file on these platforms:

OSX Linux

Uzaaft avatar Dec 22 '21 19:12 Uzaaft

Great idea - thanks for raising. We definitely need better docs on this!

Hellebore avatar Dec 23 '21 10:12 Hellebore

Relevant draft PR where we would like to iron this out : https://github.com/neovim/nvim-lspconfig/pull/1495

Uzaaft avatar Dec 23 '21 11:12 Uzaaft

@Hellebore Do you have a timeline for when this will be documented?

Uzaaft avatar Dec 28 '21 13:12 Uzaaft

Hi @Uzaaft, sorry for the long delay on this one.

We've decided that auth.yaml is an implementation detail and we're not going to document it.

Instead, the way to populate this correctly is:

  • Install the CLI with pip install sourcery-cli
  • Run sourcery login

This will work correctly on all platforms

brendanator avatar Oct 03 '22 09:10 brendanator