Documentation customchannels #13840
Documentation customchannels #13840
Conversation
|
We require contributors to sign our Contributor License Agreement and we don't have one on file for @sohamvakani. In order for us to review and merge your code, please e-sign the Contributor License Agreement PDF. We then need to manually verify your signature, merge the PR (conda/infrastructure#921), and ping the bot to refresh the PR. |
| @@ -62,6 +62,30 @@ repository, an administrator can set both :ref:`channel alias <channel-alias>` a | |||
| - http://some.custom/channel | |||
| - file:///some/local/directory | |||
|
|
|||
| .. _custom_mutlichannels: | |||
|
|
|||
| ``custom_multichannels``: Custom channels | |||
There was a problem hiding this comment.
| ``custom_multichannels``: Custom channels | |
| ``custom_multichannels``: Define custom multi-channels |
|
|
||
| Other multichannels can be defined with ``custom_multichannels`` in your conda configuration file | ||
| ``.condarc`` using a dictionary format where keys are names of multichannels and the value is a list | ||
| containing channel names or URLs. Channels specified here will have lower priority than default channels. |
There was a problem hiding this comment.
| containing channel names or URLs. Channels specified here will have lower priority than default channels. | |
| containing channel names or URLs. ``custom_multichannels`` configuration allows one to reference these custom multi-channels by name in ``conda`` commands or to include them in the ``channels`` list. |
I don't believe this is true about custom multi-channels having a lower priority. As I understand a user can create a custom multi-channel and put it in the list of channels before the defaults? But I might be wrong @travishathaway
There was a problem hiding this comment.
Yes, that's corrrect. A channel's priority depends a number of things and there's no reason that a multi-channel would have a lower priority than the default channel just because it's a multi-channel and not a normal channel.
defaults (the default channel) is itself a multi-channel so that's another reason that doesn't make sense.
| my_channel: https://mychannel.example.com | ||
| another_channel: file:///path/to/local/channel | ||
|
|
||
| Note: This is not a substitute for mirrors |
There was a problem hiding this comment.
| Note: This is not a substitute for mirrors | |
| .. note:: | |
| ``custom_multichannels`` is not a substitute for mirrors. |
@travishathaway maybe you can expand on this, I am not sure how to explain why it is not a sub for mirrors.
There was a problem hiding this comment.
I think it's actually best for us to leave it out entirely. I know it says to include this in the issue.
I say that because I think that will just confuse users. I will update the original issue to reflect this.
| custom_multichannels: | ||
| my_channel: https://mychannel.example.com | ||
| another_channel: file:///path/to/local/channel |
There was a problem hiding this comment.
| custom_multichannels: | |
| my_channel: https://mychannel.example.com | |
| another_channel: file:///path/to/local/channel | |
| custom_multichannels: | |
| my_channel: | |
| - https://channel.example.com | |
| - https://anotherchannel.example.com |
|
|
||
| ### Docs | ||
|
|
||
| * Added documentation for custom_multichannels in user guide |
There was a problem hiding this comment.
| * Added documentation for custom_multichannels in user guide | |
| * Added documentation for custom_multichannels in user guide. (#13796 via #13840) |
Added issue and PR number
| my_channel: https://mychannel.example.com | ||
| another_channel: file:///path/to/local/channel | ||
|
|
||
| Note: This is not a substitute for mirrors |
There was a problem hiding this comment.
| Note: This is not a substitute for mirrors |
|
@conda-bot check |
conda-bot
added
the
cla-signed
Description
This PR adds documentation for the custom_multichannels command that was not present in the user guide documentation. This is for issue #13796
Checklist - did you ...
newsdirectory (using the template) for the next release's release notes?