mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-12-23 08:56:29 +00:00
moved setup docs to setup dir
This commit is contained in:
parent
a6f67474f8
commit
9d9a068db8
16 changed files with 33 additions and 44 deletions
4
doc/build/README.md
vendored
4
doc/build/README.md
vendored
|
@ -1,9 +1,9 @@
|
||||||
* [Overview](overview.md)
|
* [Overview](overview.md)
|
||||||
* [Environment](environment.md)
|
* [Variables](env.md)
|
||||||
* [Clone](clone.md)
|
* [Clone](clone.md)
|
||||||
* [Build](build.md)
|
* [Build](build.md)
|
||||||
* [Services](services.md)
|
* [Services](services.md)
|
||||||
* [Publish](publish.md)
|
* [Publish](publish.md)
|
||||||
* [Deploy](deploy.md)
|
* [Deploy](deploy.md)
|
||||||
* [Notify](notify.md)
|
* [Notify](notify.md)
|
||||||
* [Matrix](martrix.md)
|
* [Matrix](matrix.md)
|
||||||
|
|
0
doc/build/badges.md
vendored
Normal file
0
doc/build/badges.md
vendored
Normal file
36
doc/build/deploy.md
vendored
36
doc/build/deploy.md
vendored
|
@ -11,6 +11,24 @@ deploy:
|
||||||
token: f10e2821bbbea5
|
token: f10e2821bbbea5
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Deploy conditions
|
||||||
|
|
||||||
|
Use the `when` attribute to limit deployments to a specific branch:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
deploy:
|
||||||
|
heroku:
|
||||||
|
when:
|
||||||
|
branch: master
|
||||||
|
|
||||||
|
# you can also do simple matching
|
||||||
|
|
||||||
|
google_appengine:
|
||||||
|
when:
|
||||||
|
branch: feature/*
|
||||||
|
```
|
||||||
|
|
||||||
|
<!--
|
||||||
## Deploy plugins
|
## Deploy plugins
|
||||||
|
|
||||||
Deployment plugins are Docker images that attach to your build environment at runtime. They are declared in the `.drone.yml` using the following format:
|
Deployment plugins are Docker images that attach to your build environment at runtime. They are declared in the `.drone.yml` using the following format:
|
||||||
|
@ -66,20 +84,4 @@ The `image` attribute is useful when you need to invoke the same plugin multiple
|
||||||
when:
|
when:
|
||||||
branch: stage
|
branch: stage
|
||||||
```
|
```
|
||||||
|
-->
|
||||||
## Deploy conditions
|
|
||||||
|
|
||||||
Use the `when` attribute to limit deployments to a specific branch:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
deploy:
|
|
||||||
heroku:
|
|
||||||
when:
|
|
||||||
branch: master
|
|
||||||
|
|
||||||
# you can also do simple matching
|
|
||||||
|
|
||||||
google_appengine:
|
|
||||||
when:
|
|
||||||
branch: feature/*
|
|
||||||
```
|
|
||||||
|
|
8
doc/build/env.md
vendored
8
doc/build/env.md
vendored
|
@ -1,8 +1,4 @@
|
||||||
# Environment
|
# Variables
|
||||||
|
|
||||||
The build environment is largely defined by the Docker image you specify in the `.drone.yml`. In addition, Drone will inject default environment variable and private variables.
|
|
||||||
|
|
||||||
## Environment Variables
|
|
||||||
|
|
||||||
The build environment has access to the following environment variables:
|
The build environment has access to the following environment variables:
|
||||||
|
|
||||||
|
@ -17,7 +13,7 @@ The build environment has access to the following environment variables:
|
||||||
|
|
||||||
## Private Variables
|
## Private Variables
|
||||||
|
|
||||||
Drone allows you to store sensitive data external to the `.drone.yml` and inject at runtime. You can declare private variables in the repository settings screen. These variables are injected into the `.drone.yml` at runtime using the `$$` notation.
|
Drone also lets you to store sensitive data external to the `.drone.yml` and inject at runtime. You can declare private variables in the repository settings screen. These variables are injected into the `.drone.yml` at runtime using the `$$` notation.
|
||||||
|
|
||||||
An example `.drone.yml` expecting the `HEROKU_TOKEN` private variable:
|
An example `.drone.yml` expecting the `HEROKU_TOKEN` private variable:
|
||||||
|
|
||||||
|
|
2
doc/build/overview.md
vendored
2
doc/build/overview.md
vendored
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
In order to configure your build, you must include a `.drone.yml` file in the root of your repository. This documentation describes the `.drone.yml` configuration file format.
|
In order to configure your build, you must include a `.drone.yml` file in the root of your repository. This documentation describes the `.drone.yml` configuration file format.
|
||||||
|
|
||||||
Example `.drone.yml` file for a Go repository:
|
Example `.drone.yml` for a Go repository:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
build:
|
build:
|
||||||
|
|
18
doc/build/services.md
vendored
18
doc/build/services.md
vendored
|
@ -38,21 +38,3 @@ The service container configuration options:
|
||||||
* `net` - sets the container [network mode](https://docs.docker.com/articles/networking/#container-networking) [1]
|
* `net` - sets the container [network mode](https://docs.docker.com/articles/networking/#container-networking) [1]
|
||||||
|
|
||||||
[1] Some build options are disabled for security reasons, including `volumes`, `privileged` and `net`. To enable these options, a system administrator must white-list your repository as trusted. This can be done via the repository settings screen.
|
[1] Some build options are disabled for security reasons, including `volumes`, `privileged` and `net`. To enable these options, a system administrator must white-list your repository as trusted. This can be done via the repository settings screen.
|
||||||
|
|
||||||
## Service images
|
|
||||||
|
|
||||||
The `image` attribute supports any valid Docker image name:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# Docker library image
|
|
||||||
image: postgres
|
|
||||||
|
|
||||||
# Docker library image, with tag
|
|
||||||
image: postgres:9.2
|
|
||||||
|
|
||||||
# Docker image, full name, with tag
|
|
||||||
image: library/postgres:9.2
|
|
||||||
|
|
||||||
# fully qualified Docker image URI, with tag
|
|
||||||
image: index.docker.io/library/postgres:9.2
|
|
||||||
```
|
|
||||||
|
|
9
doc/setup/README.md
Normal file
9
doc/setup/README.md
Normal file
|
@ -0,0 +1,9 @@
|
||||||
|
* [Install](#)
|
||||||
|
* [Docker](install.md)
|
||||||
|
* [Remotes](#)
|
||||||
|
* [GitHub](github.md)
|
||||||
|
* [GitLab](gitlab.md)
|
||||||
|
* [Bitbucket](bitbucket.md)
|
||||||
|
* [Database](#)
|
||||||
|
* [SQLite](sqlite.md)
|
||||||
|
* [Postgres](postgres.md)
|
Loading…
Reference in a new issue