From 196e2b6acf592d036878708b4bc650d0d3ed853f Mon Sep 17 00:00:00 2001 From: Patrick Schratz Date: Fri, 22 Nov 2024 09:28:41 +0100 Subject: [PATCH] Improve project settings descriptions (#4410) Co-authored-by: Robert Kaussow Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com> Co-authored-by: Anbraten Co-authored-by: Anbraten <6918444+anbraten@users.noreply.github.com> Co-authored-by: 6543 <6543@obermui.de> --- cli/lint/lint.go | 2 +- cmd/server/flags.go | 2 +- docs/docs/20-usage/75-project-settings.md | 6 ++-- .../30-administration/10-server-config.md | 4 +-- .../20-usage/71-project-settings.md | 6 ++-- .../20-usage/75-project-settings.md | 6 ++-- .../20-usage/75-project-settings.md | 6 ++-- .../20-usage/75-project-settings.md | 6 ++-- web/src/assets/locales/en.json | 36 +++++++++---------- web/src/views/repo/settings/General.vue | 4 +-- 10 files changed, 39 insertions(+), 39 deletions(-) diff --git a/cli/lint/lint.go b/cli/lint/lint.go index d28a860336..3872ef0930 100644 --- a/cli/lint/lint.go +++ b/cli/lint/lint.go @@ -45,7 +45,7 @@ var Command = &cli.Command{ &cli.StringSliceFlag{ Sources: cli.EnvVars("WOODPECKER_PLUGINS_TRUSTED_CLONE"), Name: "plugins-trusted-clone", - Usage: "Plugins which are trusted to handle the netrc info in clone steps", + Usage: "Plugins which are trusted to handle Git credentials in clone steps", Value: constant.TrustedClonePlugins, }, &cli.BoolFlag{ diff --git a/cmd/server/flags.go b/cmd/server/flags.go index 6ef1f37f0e..86f7a9abb7 100644 --- a/cmd/server/flags.go +++ b/cmd/server/flags.go @@ -192,7 +192,7 @@ var flags = append([]cli.Flag{ &cli.StringSliceFlag{ Sources: cli.EnvVars("WOODPECKER_PLUGINS_TRUSTED_CLONE"), Name: "plugins-trusted-clone", - Usage: "Plugins which are trusted to handle the netrc info in clone steps", + Usage: "Plugins which are trusted to handle Git credentials in clone steps", Value: constant.TrustedClonePlugins, }, &cli.StringSliceFlag{ diff --git a/docs/docs/20-usage/75-project-settings.md b/docs/docs/20-usage/75-project-settings.md index 26f2c0a1fd..c15bba2eca 100644 --- a/docs/docs/20-usage/75-project-settings.md +++ b/docs/docs/20-usage/75-project-settings.md @@ -39,12 +39,12 @@ Only server admins can set this option. If you are not a server admin this optio ::: -## Only inject netrc credentials into trusted clone plugins +## Only inject Git credentials into trusted clone plugins -The clone step may require git credentials (e.g. for private repos) which are injected via `netrc`. +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. +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. diff --git a/docs/docs/30-administration/10-server-config.md b/docs/docs/30-administration/10-server-config.md index 2556ef664d..902edf82c2 100644 --- a/docs/docs/30-administration/10-server-config.md +++ b/docs/docs/30-administration/10-server-config.md @@ -396,8 +396,8 @@ You should specify the tag of your images too, as this enforces exact matches. > Defaults are defined in [shared/constant/constant.go](https://github.com/woodpecker-ci/woodpecker/blob/main/shared/constant/constant.go) -Plugins which are trusted to handle the netrc info in clone steps. -If a clone step use an image not in this list, the netrc will not be injected and an user has to use other methods (e.g. secrets) to clone non public repos. +Plugins which are trusted to handle the Git credential info in clone steps. +If a clone step use an image not in this list, Git credentials will not be injected and users have to use other methods (e.g. secrets) to clone non-public repos. You should specify the tag of your images too, as this enforces exact matches. diff --git a/docs/versioned_docs/version-1.0/20-usage/71-project-settings.md b/docs/versioned_docs/version-1.0/20-usage/71-project-settings.md index ef2d85d520..6626cf1a32 100644 --- a/docs/versioned_docs/version-1.0/20-usage/71-project-settings.md +++ b/docs/versioned_docs/version-1.0/20-usage/71-project-settings.md @@ -33,12 +33,12 @@ Only server admins can set this option. If you are not a server admin this optio ::: -### Only inject netrc credentials into trusted clone plugins +### Only inject Git credentials into trusted clone plugins -The clone step may require git credentials (e.g. for private repos) which are injected via `netrc`. +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. +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. diff --git a/docs/versioned_docs/version-2.5/20-usage/75-project-settings.md b/docs/versioned_docs/version-2.5/20-usage/75-project-settings.md index e9b21c0ad7..d57b3a9323 100644 --- a/docs/versioned_docs/version-2.5/20-usage/75-project-settings.md +++ b/docs/versioned_docs/version-2.5/20-usage/75-project-settings.md @@ -40,12 +40,12 @@ Only server admins can set this option. If you are not a server admin this optio ::: -## Only inject netrc credentials into trusted clone plugins +## Only inject Git credentials into trusted clone plugins -The clone step may require git credentials (e.g. for private repos) which are injected via `netrc`. +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. +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. diff --git a/docs/versioned_docs/version-2.6/20-usage/75-project-settings.md b/docs/versioned_docs/version-2.6/20-usage/75-project-settings.md index e9b21c0ad7..d57b3a9323 100644 --- a/docs/versioned_docs/version-2.6/20-usage/75-project-settings.md +++ b/docs/versioned_docs/version-2.6/20-usage/75-project-settings.md @@ -40,12 +40,12 @@ Only server admins can set this option. If you are not a server admin this optio ::: -## Only inject netrc credentials into trusted clone plugins +## Only inject Git credentials into trusted clone plugins -The clone step may require git credentials (e.g. for private repos) which are injected via `netrc`. +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. +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. diff --git a/docs/versioned_docs/version-2.7/20-usage/75-project-settings.md b/docs/versioned_docs/version-2.7/20-usage/75-project-settings.md index e9b21c0ad7..d57b3a9323 100644 --- a/docs/versioned_docs/version-2.7/20-usage/75-project-settings.md +++ b/docs/versioned_docs/version-2.7/20-usage/75-project-settings.md @@ -40,12 +40,12 @@ Only server admins can set this option. If you are not a server admin this optio ::: -## Only inject netrc credentials into trusted clone plugins +## Only inject Git credentials into trusted clone plugins -The clone step may require git credentials (e.g. for private repos) which are injected via `netrc`. +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. +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. diff --git a/web/src/assets/locales/en.json b/web/src/assets/locales/en.json index 577325f570..8b4624e97b 100644 --- a/web/src/assets/locales/en.json +++ b/web/src/assets/locales/en.json @@ -42,8 +42,8 @@ "show_pipelines": "Show pipelines" }, "deploy_pipeline": { - "title": "Trigger deployment event for current pipeline #{pipelineId}", - "enter_target": "Target deployment environment", + "title": "Trigger a 'deployment' event for current pipeline #{pipelineId}", + "enter_target": "Target 'deployment' environment", "enter_task": "Deployment task", "trigger": "Deploy", "variables": { @@ -88,7 +88,7 @@ "general": "General", "project": "Project settings", "save": "Save settings", - "success": "Repository settings updated", + "success": "Project settings updated", "pipeline_path": { "path": "Pipeline path", "default": "By default: .woodpecker/*.{'{yaml,yml}'} -> .woodpecker.yaml -> .woodpecker.yml", @@ -97,29 +97,29 @@ }, "allow_pr": { "allow": "Allow Pull Requests", - "desc": "Pipelines can run on pull requests." + "desc": "Allow pipelines to run on pull requests." }, "allow_deploy": { - "allow": "Allow deployments", - "desc": "Allow deployments from successful pipelines. Only use if you trust all users with push access." + "allow": "Allow 'deployment' events.", + "desc": "Permit 'deployment' runs for successful pipelines. All users with with push permissions can trigger these, so use with caution." }, "netrc_only_trusted": { - "netrc_only_trusted": "Only inject netrc credentials into trusted clone plugins", - "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." + "netrc_only_trusted": "Only inject git credentials into trusted clone plugins", + "desc": "When enabled, git credentials are accessible only to trusted clone plugins specified in WOODPECKER_PLUGINS_TRUSTED_CLONE. Otherwise, custom clone plugins can use git credentials. This setting has no affect on non-clone steps." }, "trusted": { "trusted": "Trusted", "network": { "network": "Network", - "desc": "Underlying pipeline containers get access to network privileges like changing DNS." + "desc": "Pipeline containers get access to network privileges like changing DNS." }, "volumes": { "volumes": "Volumes", - "desc": "Underlying pipeline containers get access to volume privileges." + "desc": "Pipeline containers are allowed to mount volumes." }, "security": { "security": "Security", - "desc": "Underlying pipeline containers get access to security privileges." + "desc": "Pipeline containers get access to security privileges." } }, "timeout": { @@ -128,7 +128,7 @@ }, "cancel_prev": { "cancel": "Cancel previous pipelines", - "desc": "Enable to cancel pending and running pipelines of the same event and context before starting the newly triggered one." + "desc": "Selected event triggers will cancel pending and running pipelines of the same event before starting the most recent one." } }, "crons": { @@ -502,13 +502,13 @@ "access_denied": "You are not allowed to access this instance", "invalid_state": "The OAuth state is invalid", "require_approval": { - "require_approval_for": "Require approval for", - "none": "No approval required", - "none_desc": "This setting can be dangerous and should only be used on private forges where all users are trusted.", - "forks": "Pull request from forked repositories", + "desc": "Prevent malicious pipelines from exposing secrets or running harmful tasks by approving them before execution.", + "require_approval_for": "Approval requirements", + "none": "None", + "none_desc": "Every event triggers pipelines, including pull requests. This setting can be dangerous and is only recommended for private instances.", + "forks": "Pull request from forked repository", "pull_requests": "All pull requests", - "all_events": "All events from forge", - "desc": "Prevent malicious pipelines from exposing secrets or running harmful tasks by approving them before execution." + "all_events": "All events from forge" }, "all_repositories": "All repositories", "no_search_results": "No results found" diff --git a/web/src/views/repo/settings/General.vue b/web/src/views/repo/settings/General.vue index f6e148fa3d..a03cf00509 100644 --- a/web/src/views/repo/settings/General.vue +++ b/web/src/views/repo/settings/General.vue @@ -1,9 +1,9 @@