mirrors/woodpecker
1
0
Fork 0
mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2024-12-01 06:11:03 +00:00
Code Issues Projects Releases Wiki Activity

Update netrc option description (#4342)

Browse source 
Co-authored-by: Robert Kaussow <mail@thegeeklab.de>
This commit is contained in:
Patrick Schratz 2024-11-10 16:39:15 +01:00 committed by GitHub
parent 8882ebcdbd
commit 9a61cdb15a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 47 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/docs/20-usage/75-project-settings.md
View file

@ -40,9 +40,16 @@ Only server admins can set this option. If you are not a server admin this optio
::: :::
## Only inject netrc credentials into trusted containers ## Only inject netrc credentials into trusted clone plugins
Cloning pipeline step may need git credentials. They are injected via netrc. By default, they're only injected if this option is enabled, the repo is trusted ([see above](#trusted)) or the image is a trusted clone image. If you uncheck the option, git credentials will be injected into any container in clone step. The clone step may require git credentials (e.g. for private repos) which are injected via `netrc`.
By default, they are only injected into trusted clone plugins listed in the env var `WOODPECKER_PLUGINS_TRUSTED_CLONE`.
If this option is disabled, the git credentials are injected into every clone plugin, regardless of whether it is trusted or not.
:::note
This option has no effect on steps other than the clone step.
:::
## Project visibility ## Project visibility

11
docs/versioned_docs/version-1.0/20-usage/71-project-settings.md
View file

@ -33,9 +33,16 @@ Only server admins can set this option. If you are not a server admin this optio
::: :::
### Only inject netrc credentials into trusted containers ### Only inject netrc credentials into trusted clone plugins
Cloning pipeline step may need git credentials. They are injected via netrc. By default, they're only injected if this option is enabled, the repo is trusted ([see above](#trusted)) or the image is a trusted clone image. If you uncheck the option, git credentials will be injected into any container in clone step. The clone step may require git credentials (e.g. for private repos) which are injected via `netrc`.
By default, they are only injected into trusted clone plugins listed in the env var `WOODPECKER_PLUGINS_TRUSTED_CLONE`.
If this option is disabled, the git credentials are injected into every clone plugin, regardless of whether it is trusted or not.
:::note
This option has no effect on steps other than the clone step.
:::
## Project visibility ## Project visibility

11
docs/versioned_docs/version-2.5/20-usage/75-project-settings.md
View file

@ -40,9 +40,16 @@ Only server admins can set this option. If you are not a server admin this optio
::: :::
## Only inject netrc credentials into trusted containers ## Only inject netrc credentials into trusted clone plugins
Cloning pipeline step may need git credentials. They are injected via netrc. By default, they're only injected if this option is enabled, the repo is trusted ([see above](#trusted)) or the image is a trusted clone image. If you uncheck the option, git credentials will be injected into any container in clone step. The clone step may require git credentials (e.g. for private repos) which are injected via `netrc`.
By default, they are only injected into trusted clone plugins listed in the env var `WOODPECKER_PLUGINS_TRUSTED_CLONE`.
If this option is disabled, the git credentials are injected into every clone plugin, regardless of whether it is trusted or not.
:::note
This option has no effect on steps other than the clone step.
:::
## Project visibility ## Project visibility

11
docs/versioned_docs/version-2.6/20-usage/75-project-settings.md
View file

@ -40,9 +40,16 @@ Only server admins can set this option. If you are not a server admin this optio
::: :::
## Only inject netrc credentials into trusted containers ## Only inject netrc credentials into trusted clone plugins
Cloning pipeline step may need git credentials. They are injected via netrc. By default, they're only injected if this option is enabled, the repo is trusted ([see above](#trusted)) or the image is a trusted clone image. If you uncheck the option, git credentials will be injected into any container in clone step. The clone step may require git credentials (e.g. for private repos) which are injected via `netrc`.
By default, they are only injected into trusted clone plugins listed in the env var `WOODPECKER_PLUGINS_TRUSTED_CLONE`.
If this option is disabled, the git credentials are injected into every clone plugin, regardless of whether it is trusted or not.
:::note
This option has no effect on steps other than the clone step.
:::
## Project visibility ## Project visibility

11
docs/versioned_docs/version-2.7/20-usage/75-project-settings.md
View file

@ -40,9 +40,16 @@ Only server admins can set this option. If you are not a server admin this optio
::: :::
## Only inject netrc credentials into trusted containers ## Only inject netrc credentials into trusted clone plugins
Cloning pipeline step may need git credentials. They are injected via netrc. By default, they're only injected if this option is enabled, the repo is trusted ([see above](#trusted)) or the image is a trusted clone image. If you uncheck the option, git credentials will be injected into any container in clone step. The clone step may require git credentials (e.g. for private repos) which are injected via `netrc`.
By default, they are only injected into trusted clone plugins listed in the env var `WOODPECKER_PLUGINS_TRUSTED_CLONE`.
If this option is disabled, the git credentials are injected into every clone plugin, regardless of whether it is trusted or not.
:::note
This option has no effect on steps other than the clone step.
:::
## Project visibility ## Project visibility

4
web/src/assets/locales/en.json
View file

@ -93,8 +93,8 @@
"desc": "Every pipeline needs to be approved before being executed." "desc": "Every pipeline needs to be approved before being executed."
}, },
"netrc_only_trusted": { "netrc_only_trusted": {
"netrc_only_trusted": "Only inject netrc credentials into trusted containers", "netrc_only_trusted": "Only inject netrc credentials into trusted clone plugins",
"desc": "Only inject netrc credentials into trusted containers (recommended)." "desc": "If enabled, git netrc credentials are only available for trusted clone plugins set in `WOODPECKER_PLUGINS_TRUSTED_CLONE`. Otherwise, all clone plugins can use the netrc credentials. This option has no effect on non-clone steps."
}, },
"trusted": { "trusted": {
"trusted": "Trusted", "trusted": "Trusted",