mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-25 05:23:58 -07:00
8f8a0e1d7c
Some checks are pending
EOL CI / EOL Sanity (Ⓐ2.17) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.17+py3.10) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.17+py3.12) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.17+py3.7) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+alpine319+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+alpine319+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+alpine319+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+fedora39+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+fedora39+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+fedora39+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+ubuntu2004+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+ubuntu2004+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+ubuntu2004+py:azp/posix/3/) (push) Waiting to run
nox / Run extra sanity tests (push) Waiting to run
* Adjust all __future__ imports: for i in $(grep -REl "__future__.*absolute_import" plugins/ tests/); do sed -e 's/from __future__ import .*/from __future__ import annotations/g' -i $i; done * Remove all UTF-8 encoding specifications for Python source files: for i in $(grep -REl '[-][*]- coding: utf-8 -[*]-' plugins/ tests/); do sed -e '/^# -\*- coding: utf-8 -\*-/d' -i $i; done * Remove __metaclass__ = type: for i in $(grep -REl '__metaclass__ = type' plugins/ tests/); do sed -e '/^__metaclass__ = type/d' -i $i; done
42 lines
1.5 KiB
Python
42 lines
1.5 KiB
Python
|
|
# Copyright (c) 2019, Evgeniy Krysanov <evgeniy.krysanov@gmail.com>
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
from __future__ import annotations
|
|
|
|
|
|
class ModuleDocFragment(object):
|
|
|
|
# Standard documentation fragment
|
|
DOCUMENTATION = r"""
|
|
options:
|
|
client_id:
|
|
description:
|
|
- The OAuth consumer key.
|
|
- If not set the environment variable E(BITBUCKET_CLIENT_ID) is used.
|
|
type: str
|
|
client_secret:
|
|
description:
|
|
- The OAuth consumer secret.
|
|
- If not set the environment variable E(BITBUCKET_CLIENT_SECRET) is used.
|
|
type: str
|
|
user:
|
|
description:
|
|
- The username.
|
|
- If not set the environment variable E(BITBUCKET_USERNAME) is used.
|
|
- O(ignore:username) is an alias of O(user) since community.general 6.0.0. It was an alias of O(workspace) before.
|
|
type: str
|
|
version_added: 4.0.0
|
|
aliases: [username]
|
|
password:
|
|
description:
|
|
- The App password.
|
|
- If not set the environment variable E(BITBUCKET_PASSWORD) is used.
|
|
type: str
|
|
version_added: 4.0.0
|
|
notes:
|
|
- Bitbucket OAuth consumer key and secret can be obtained from Bitbucket profile -> Settings -> Access Management -> OAuth.
|
|
- Bitbucket App password can be created from Bitbucket profile -> Personal Settings -> App passwords.
|
|
- If both OAuth and Basic Auth credentials are passed, OAuth credentials take precedence.
|
|
"""
|