woodpecker/docs/versioned_docs/version-2.5/20-usage/75-project-settings.md
Anbraten 13c6150b9a
Create 2.5 docs (#3732)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: qwerty287 <qwerty287@posteo.de>
Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com>
2024-06-01 08:34:17 +02:00

3 KiB

Project settings

As the owner of a project in Woodpecker you can change project related settings via the web interface.

project settings

Pipeline path

The path to the pipeline config file or folder. By default it is left empty which will use the following configuration resolution .woodpecker/*.{yaml,yml} -> .woodpecker.yaml -> .woodpecker.yml. If you set a custom path Woodpecker tries to load your configuration or fails if no configuration could be found at the specified location. To use a multiple workflows with a custom path you have to change it to a folder path ending with a / like .woodpecker/.

Repository hooks

Your Version-Control-System will notify Woodpecker about events via webhooks. If you want your pipeline to only run on specific webhooks, you can check them with this setting.

Allow pull requests

Enables handling webhook's pull request event. If disabled, then pipeline won't run for pull requests.

Allow deployments

Enables a pipeline to be started with the deploy event from a successful pipeline.

:::danger Only activate this option if you trust all users who have push access to your repository. Otherwise, these users will be able to steal secrets that are only available for deploy events. :::

Protected

Every pipeline initiated by an webhook event needs to be approved by a project members with push permissions before being executed. The protected option can be used as an additional review process before running potentially harmful pipelines. Especially if pipelines can be executed by third-parties through pull-requests.

Trusted

If you set your project to trusted, a pipeline step and by this the underlying containers gets access to escalated capabilities like mounting volumes.

:::note

Only server admins can set this option. If you are not a server admin this option won't be shown in your project settings.

:::

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) or the image is a trusted clone image. If you uncheck the option, git credentials will be injected into any container in clone step.

Project visibility

You can change the visibility of your project by this setting. If a user has access to a project they can see all builds and their logs and artifacts. Settings, Secrets and Registries can only be accessed by owners.

  • Public Every user can see your project without being logged in.
  • Internal Only authenticated users of the Woodpecker instance can see this project.
  • Private Only you and other owners of the repository can see this project.

Timeout

After this timeout a pipeline has to finish or will be treated as timed out.

Cancel previous pipelines

By enabling this option for a pipeline event previous pipelines of the same event and context will be canceled before starting the newly triggered one.