apache / apache/buildstream

.netrc behaviour is not documented

Open
#2,159 2 comments 4 reactions 1 assignee Claimed by @AedanM View on GitHub
documentation
Dominant language
Python
Stars
140
Forks
45
Avg merge
1d 3h
Merged PRs (30d)
6

Description

The Source subclass [DownloadableFileSource](https://docs.buildstream.build/master/buildstream.downloadablefilesource.html) 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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.