From 16e96743c5663b811a7e9453818dcf268e874895 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gina=20H=C3=A4u=C3=9Fge?= Date: Thu, 6 Jul 2017 16:30:44 +0200 Subject: [PATCH] Docs for api_user/api_password on bitbucket_commit --- docs/bundledplugins/softwareupdate.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/bundledplugins/softwareupdate.rst b/docs/bundledplugins/softwareupdate.rst index 17efc535..763a0de5 100644 --- a/docs/bundledplugins/softwareupdate.rst +++ b/docs/bundledplugins/softwareupdate.rst @@ -198,6 +198,13 @@ Version checks * ``branch``: Branch of the Bitbucket repository to check, defaults to ``master`` if not set. * ``current``: Current commit hash. Will be updated automatically. + * ``api_user``: (mandatory only for private repositories) Bitbucket user name (not email address). + Requires ``api_password`` to be set. Hint: This is used for the check only. For the actual + download you might register your public SSH key as access key for the according repo and + configure this as pip URL in ``config.yaml``: ``git+ssh://git@bitbucket.org/my_user/my_repo.git@{target_version}`` + * ``api_password``: (mandatory only for private repositories) App password. Requires + ``api_user`` to be set. **Important**: Never use your actual Bitbucket login password. Generate + a new app password. App passwords are user specific on Bitbucket. * ``git_commit``: Checks a local git repository for new commits on its configured remote. Additional config parameters: