2019-11-13 14:47:14 +00:00
# Welcome to Woodpecker
2019-11-13 11:26:38 +00:00
2023-12-19 13:12:18 +00:00
Woodpecker is a simple yet powerful CI/CD engine with great extensibility. It focuses on executing pipelines inside [containers ](https://opencontainers.org/ ).
2023-07-25 10:41:58 +00:00
If you are already using containers in your daily workflow, you'll for sure love Woodpecker.
2019-11-13 11:26:38 +00:00
2021-09-11 15:10:32 +00:00

2019-11-15 10:13:16 +00:00
2021-09-11 15:10:32 +00:00
## .woodpecker.yml
2019-11-13 11:26:38 +00:00
2021-09-11 15:10:32 +00:00
- Place your pipeline in a file named `.woodpecker.yml` in your repository
2019-11-13 14:47:14 +00:00
- Pipeline steps can be named as you like
- Run any command in the commands section
2019-11-13 11:26:38 +00:00
2023-11-26 18:31:05 +00:00
```yaml title=".woodpecker.yml"
2023-06-07 10:04:37 +00:00
steps:
2019-11-13 14:47:14 +00:00
build:
image: debian
commands:
- echo "This is the build step"
a-test-step:
image: debian
commands:
- echo "Testing.."
```
2023-06-07 10:04:37 +00:00
### Steps are containers
2019-11-13 14:47:14 +00:00
2022-04-06 15:15:28 +00:00
- Define any container image as context
2023-07-25 10:41:58 +00:00
- either use your own and install the needed tools in a custom image
- or search for available images that are already tailored for your needs in image registries like [Docker Hub ](https://hub.docker.com/search?type=image )
- List the commands that should be executed in the container
2019-11-13 14:47:14 +00:00
```diff
2023-06-07 10:04:37 +00:00
steps:
2019-11-13 14:47:14 +00:00
build:
2021-09-11 15:10:32 +00:00
- image: debian
2019-11-13 14:47:14 +00:00
+ image: mycompany/image-with-awscli
commands:
- aws help
```
2019-11-13 18:50:54 +00:00
### File changes are incremental
2019-11-13 14:47:14 +00:00
2023-06-07 10:04:37 +00:00
- Woodpecker clones the source code in the beginning
2023-07-25 10:41:58 +00:00
- File changes are persisted throughout individual steps as the same volume is being mounted in all steps
2019-11-13 14:47:14 +00:00
2023-11-26 18:31:05 +00:00
```yaml title=".woodpecker.yml"
2023-06-07 10:04:37 +00:00
steps:
2019-11-13 14:47:14 +00:00
build:
image: debian
commands:
- touch myfile
a-test-step:
image: debian
commands:
- cat myfile
```
2021-10-08 16:35:56 +00:00
## Plugins are straightforward
2019-11-13 14:47:14 +00:00
- If you copy the same shell script from project to project
- Pack it into a plugin instead
- And make the yaml declarative
- Plugins are Docker images with your script as an entrypoint
2023-11-26 20:13:13 +00:00
```dockerfile title="Dockerfile"
2019-11-13 14:47:14 +00:00
FROM laszlocloud/kubectl
COPY deploy /usr/local/deploy
ENTRYPOINT ["/usr/local/deploy"]
```
```bash
# deploy
kubectl apply -f $PLUGIN_TEMPLATE
```
2023-11-26 18:31:05 +00:00
```yaml title=".woodpecker.yml"
2023-06-07 10:04:37 +00:00
steps:
2019-11-13 14:47:14 +00:00
deploy-to-k8s:
image: laszlocloud/my-k8s-plugin
2022-11-02 17:02:41 +00:00
settings:
template: config/k8s/service.yml
2019-11-13 14:47:14 +00:00
```
2019-11-13 11:26:38 +00:00
2022-08-31 23:52:52 +00:00
See [plugin docs ](./20-usage/51-plugins/10-plugins.md ).
2023-02-28 16:30:25 +00:00
## Continue reading
- [Create a Woodpecker pipeline for your repository ](./20-usage/10-intro.md )
2023-10-23 12:37:29 +00:00
- [Setup your own Woodpecker instance ](./30-administration/00-deployment/00-overview.md )