mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-11-30 08:06:52 +02:00
minor updates to docs (#712)
* correct minor spellings in the docs * add warning about artifacts not being shared in multi-pipelines * highlight note on multi-pipelines docs page * update mentions of GitLab to use its official notation (camel case)
This commit is contained in:
parent
be11e57976
commit
074e2cd38a
@ -158,7 +158,7 @@ when:
|
||||
## `path`
|
||||
|
||||
:::info
|
||||
This feature is currently only available for GitHub, Gitlab and Gitea.
|
||||
This feature is currently only available for GitHub, GitLab and Gitea.
|
||||
Pull requests aren't supported by gitea at the moment ([go-gitea/gitea#18228](https://github.com/go-gitea/gitea/pull/18228)).
|
||||
Path conditions are ignored for tag events.
|
||||
:::
|
||||
|
@ -1,18 +1,24 @@
|
||||
# Multi pipelines
|
||||
|
||||
> NOTE: This Feature is only available for GitHub, Gitea & Gitlab repositories. Follow [this](https://github.com/woodpecker-ci/woodpecker/issues/131) issue to support further development.
|
||||
:::info
|
||||
This Feature is only available for GitHub, Gitea & GitLab repositories. Follow [this](https://github.com/woodpecker-ci/woodpecker/issues/131) issue to support further development.
|
||||
:::
|
||||
|
||||
By default, Woodpecker looks for the pipeline definition in `.woodpecker.yml` in the project root.
|
||||
|
||||
The Multi-Pipeline feature allows the pipeline to be split into several files and placed in the `.woodpecker/` folder. Only `.yml` files will we used and files in any subfolders like `.woodpecker/sub-folder/test.yml` will be ignored. You can set some custom path like `.my-ci/pipelines/` instead of `.woodpecker/` in the [project settings](/docs/usage/project-settings).
|
||||
The Multi-Pipeline feature allows the pipeline to be split into several files and placed in the `.woodpecker/` folder. Only `.yml` files will be used and files in any subfolders like `.woodpecker/sub-folder/test.yml` will be ignored. You can set some custom path like `.my-ci/pipelines/` instead of `.woodpecker/` in the [project settings](/docs/usage/project-settings).
|
||||
|
||||
## Rational
|
||||
|
||||
- faster lint/test feedback, the pipeline doesn't have to run fully to have a lint status pushed to the the remote
|
||||
- faster lint/test feedback, the pipeline doesn't have to run fully to have a lint status pushed to the remote
|
||||
- better organization of the pipeline along various concerns: testing, linting, feature apps
|
||||
- utilizing more agents to speed up build
|
||||
|
||||
## Example multi-pipeline definition
|
||||
:::warning
|
||||
Please note that files are only shared bewteen steps of the same pipeline (see [File changes are incremental](/docs/usage/pipeline-syntax#file-changes-are-incremental)). That means you cannot access artifacts e.g. from the `build` pipeline below in the `deploy` pipeline.
|
||||
If you still need to pass artifacts between the pipelines you need use storage [plugins](docs/usage/plugins/plugins) (e.g. one which stores files in an Amazon S3 bucket).
|
||||
:::
|
||||
|
||||
```bash
|
||||
.woodpecker/
|
||||
|
@ -1,4 +1,4 @@
|
||||
# Gitlab
|
||||
# GitLab
|
||||
|
||||
Woodpecker comes with built-in support for the GitLab version 8.2 and higher. To enable GitLab you should configure the Woodpecker container using the following environment variables:
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user