mirrors/woodpecker
1
0
Fork 0
mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2024-12-04 07:36:29 +00:00
Code Issues Projects Releases Wiki Activity

minor updates to docs (#712)

Browse source 
* 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:
jdoubleu 2022-01-20 18:24:16 +01:00 committed by GitHub
parent be11e57976
commit 074e2cd38a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 11 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/docs/20-usage/22-conditional-execution.md
View file

@ -158,7 +158,7 @@ when:
## `path` ## `path`
:::info :::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)). 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. Path conditions are ignored for tag events.
::: :::

12
docs/docs/20-usage/25-multi-pipeline.md
View file

@ -1,18 +1,24 @@
# Multi pipelines # 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. 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 ## 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 - better organization of the pipeline along various concerns: testing, linting, feature apps
- utilizing more agents to speed up build - utilizing more agents to speed up build
## Example multi-pipeline definition ## 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 ```bash
.woodpecker/ .woodpecker/

2
docs/docs/30-administration/20-vcs/40-gitlab.md
View file

@ -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: 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: