woodpecker/docs/docs/index.md

Welcome to Woodpecker

Woodpecker is a simple CI engine with great extensibility.

.woodpecker.yml

• Place your pipeline in a file named .woodpecker.yml in your repository
• Pipeline steps can be named as you like
• Run any command in the commands section

# .woodpecker.yml
pipeline:
  build:
    image: debian
    commands:
      - echo "This is the build step"
  a-test-step:
    image: debian
    commands:
      - echo "Testing.."

Build steps are containers

• Define any Docker image as context
• Install the needed tools in custom Docker images, use them as context

pipeline:
  build:
-    image: debian
+   image: mycompany/image-with-awscli
    commands:
      - aws help

File changes are incremental

• Woodpecker clones the source code in the beginning pipeline
• Changes to files are persisted through steps as the same volume is mounted to all steps

# .woodpecker.yml
pipeline:
  build:
    image: debian
    commands:
      - touch myfile
  a-test-step:
    image: debian
    commands:
      - cat myfile

Plugins are straighforward

• 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

# Dockerfile
FROM laszlocloud/kubectl
COPY deploy /usr/local/deploy
ENTRYPOINT ["/usr/local/deploy"]

# deploy
kubectl apply -f $PLUGIN_TEMPLATE

# .woodpecker.yml
pipeline:
  deploy-to-k8s:
    image: laszlocloud/my-k8s-plugin
    template: config/k8s/service.yml