mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2024-12-25 18:00:30 +00:00

and also fix / enhance some

2023-07-25 12:41:58 +02:00

2.2 KiB

Raw Blame History

Welcome to Woodpecker

Woodpecker is a simple CI engine with great extensibility. It focuses on executing pipelines inside containers. If you are already using containers in your daily workflow, you'll for sure love Woodpecker.

.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
steps:
  build:
    image: debian
    commands:
      - echo "This is the build step"
  a-test-step:
    image: debian
    commands:
      - echo "Testing.."

Steps are containers

Define any container image as context
- 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
List the commands that should be executed in the container

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

File changes are incremental

Woodpecker clones the source code in the beginning
File changes are persisted throughout individual steps as the same volume is being mounted in all steps

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

Plugins are straightforward

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
steps:
  deploy-to-k8s:
    image: laszlocloud/my-k8s-plugin
    settings:
      template: config/k8s/service.yml

See plugin docs.

2.2 KiB Raw Blame History