mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-11-18 16:01:05 +00:00
76 lines
2.5 KiB
Markdown
76 lines
2.5 KiB
Markdown
# Getting started
|
|
|
|
## Repository Activation
|
|
|
|
To activate your project navigate to your account settings. You will see a list of repositories which can be activated with a simple toggle. When you activate your repository, Woodpecker automatically adds webhooks to your version control system (e.g. GitHub).
|
|
|
|
Webhooks are used to trigger pipeline executions. When you push code to your repository, open a pull request, or create a tag, your version control system will automatically send a webhook to Woodpecker which will in turn trigger pipeline execution.
|
|
|
|
|
|
|
|
> Required Permissions
|
|
>
|
|
>The user who enables a repo in Woodpecker must have `Admin` rights on that repo, so that Woodpecker can add the webhook.
|
|
>
|
|
> Note that manually creating webhooks yourself is not possible. This is because webhooks are signed using a per-repository secret key which is not exposed to end users.
|
|
|
|
# Webhooks
|
|
|
|
When you activate your repository Woodpecker automatically add webhooks to your version control system (e.g. GitHub). There is no manual configuration required.
|
|
|
|
Webhooks are used to trigger pipeline executions. When you push code to your repository, open a pull request, or create a tag, your version control system will automatically send a webhook to Woodpecker which will in turn trigger pipeline execution.
|
|
|
|
## Configuration
|
|
|
|
To configure your pipeline you should place a `.woodpecker.yml` file in the root of your repository. The .woodpecker.yml file is used to define your pipeline steps. It is a superset of the widely used docker-compose file format.
|
|
|
|
:::info
|
|
|
|
Currently, only YAML 1.1 syntax is supported for pipeline configuration files. YAML 1.2 support is [planned for the future](https://github.com/woodpecker-ci/woodpecker/issues/517)!
|
|
|
|
:::
|
|
|
|
Example pipeline configuration:
|
|
|
|
```yaml
|
|
pipeline:
|
|
build:
|
|
image: golang
|
|
commands:
|
|
- go get
|
|
- go build
|
|
- go test
|
|
|
|
services:
|
|
postgres:
|
|
image: postgres:9.4.5
|
|
environment:
|
|
- POSTGRES_USER=myapp
|
|
```
|
|
|
|
Example pipeline configuration with multiple, serial steps:
|
|
|
|
```yaml
|
|
pipeline:
|
|
backend:
|
|
image: golang
|
|
commands:
|
|
- go get
|
|
- go build
|
|
- go test
|
|
|
|
frontend:
|
|
image: node:6
|
|
commands:
|
|
- npm install
|
|
- npm test
|
|
|
|
notify:
|
|
image: plugins/slack
|
|
channel: developers
|
|
username: woodpecker
|
|
```
|
|
|
|
## Execution
|
|
|
|
To trigger your first pipeline execution you can push code to your repository, open a pull request, or push a tag. Any of these events triggers a webhook from your version control system and execute your pipeline.
|