Skip to content

.netrc behaviour is not documented #2159

Open

Description

@tmewett

The Source subclass DownloadableFileSource reads login credentials from ~/.netrc. This class is used by the included 'tar' source as well as third-party plugins, since it's part of the public API. However, this behaviour is not documented anywhere.

It would be great to have user-facing documentation for this, ideally in its own page such that supporting plugins can link to it.

Activity

  1. juergbi commented on Jul 31, 2026

    @juergbi
    Contributor

    Yes, we should have documentation for that. When deciding on documentation structure, we should consider that other credential fetching mechanisms may be added in the future (such as credential helper support suggested in #2148 (comment) / discussed on the mailing list).

  2. AedanM commented on Aug 4, 2026

    @AedanM

    I'll take a look to add this

  3. added this to the BuildStream 2.9 milestone on Aug 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions