Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update netrc option description #4342

Merged
merged 11 commits into from
Nov 10, 2024
9 changes: 8 additions & 1 deletion docs/docs/20-usage/75-project-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,14 @@ Only server admins can set this option. If you are not a server admin this optio

## Only inject netrc credentials into trusted containers
pat-s marked this conversation as resolved.
Show resolved Hide resolved

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 need git credentials (e.g. for private repos).
These are injected via `netrc`.
By default, they're only injected into "trusted" clone plugins listed in env var `WOODPECKER_PLUGINS_TRUSTED_CLONE`.
If this option is unchecked, git credentials will be injected into any plugin used in the clone step, regardless of being listed in `WOODPECKER_PLUGINS_TRUSTED_CLONE`.

:::note
This option does not have any effect for other steps than the "clone" step.
:::
pat-s marked this conversation as resolved.
Show resolved Hide resolved

## Project visibility

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,14 @@ Only server admins can set this option. If you are not a server admin this optio

### Only inject netrc credentials into trusted containers

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 need git credentials (e.g. for private repos).
These are injected via `netrc`.
By default, they're only injected into "trusted" clone plugins listed in env var `WOODPECKER_PLUGINS_TRUSTED_CLONE`.
If this option is unchecked, git credentials will be injected into any plugin used in the clone step, regardless of being listed in `WOODPECKER_PLUGINS_TRUSTED_CLONE`.

:::note
This option does not have any effect for other steps than the "clone" step.
:::
pat-s marked this conversation as resolved.
Show resolved Hide resolved

## Project visibility

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,14 @@ Only server admins can set this option. If you are not a server admin this optio

## Only inject netrc credentials into trusted containers

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 need git credentials (e.g. for private repos).
These are injected via `netrc`.
By default, they're only injected into "trusted" clone plugins listed in env var `WOODPECKER_PLUGINS_TRUSTED_CLONE`.
If this option is unchecked, git credentials will be injected into any plugin used in the clone step, regardless of being listed in `WOODPECKER_PLUGINS_TRUSTED_CLONE`.

:::note
This option does not have any effect for other steps than the "clone" step.
:::
pat-s marked this conversation as resolved.
Show resolved Hide resolved

## Project visibility

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,14 @@ Only server admins can set this option. If you are not a server admin this optio

## Only inject netrc credentials into trusted containers

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 need git credentials (e.g. for private repos).
These are injected via `netrc`.
By default, they're only injected into "trusted" clone plugins listed in env var `WOODPECKER_PLUGINS_TRUSTED_CLONE`.
If this option is unchecked, git credentials will be injected into any plugin used in the clone step, regardless of being listed in `WOODPECKER_PLUGINS_TRUSTED_CLONE`.

:::note
This option does not have any effect for other steps than the "clone" step.
:::
pat-s marked this conversation as resolved.
Show resolved Hide resolved

## Project visibility

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,14 @@ Only server admins can set this option. If you are not a server admin this optio

## Only inject netrc credentials into trusted containers

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 need git credentials (e.g. for private repos).
These are injected via `netrc`.
By default, they're only injected into "trusted" clone plugins listed in env var `WOODPECKER_PLUGINS_TRUSTED_CLONE`.
If this option is unchecked, git credentials will be injected into any plugin used in the clone step, regardless of being listed in `WOODPECKER_PLUGINS_TRUSTED_CLONE`.

:::note
This option does not have any effect for other steps than the "clone" step.
:::
pat-s marked this conversation as resolved.
Show resolved Hide resolved

## Project visibility

Expand Down
4 changes: 2 additions & 2 deletions web/src/assets/locales/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,8 @@
"desc": "Every pipeline needs to be approved before being executed."
},
"netrc_only_trusted": {
"netrc_only_trusted": "Only inject netrc credentials into trusted containers",
"desc": "Only inject netrc credentials into trusted containers (recommended)."
"netrc_only_trusted": "Only inject netrc credentials into trusted clone step plugins.",
pat-s marked this conversation as resolved.
Show resolved Hide resolved
"desc": "If checked, git netrc credentials will only be available to plugins listed in env var `WOODPECKER_PLUGINS_TRUSTED_CLONE`. netrc credentials are required for a functional clone operation. If unchecked, this will allow untrusted clone plugins in the clone step to function properly. This option does not have effect for non-clone steps."
pat-s marked this conversation as resolved.
Show resolved Hide resolved
},
"trusted": {
"trusted": "Trusted",
Expand Down