mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2024-11-24 08:02:18 +02:00

Add a Community-Guide

template was taken from [gitea](https://github.com/go-gitea/gitea/blob/main/CONTRIBUTING.md)

Signed-off-by: 6543 <6543@obermui.de>
Co-authored-by: Anbraten <anton@ju60.de>
Co-authored-by: Malachi Soord <inverse.chi@gmail.com>

2021-09-11 23:45:18 +02:00

3.7 KiB

Raw Blame History

Woodpecker

Woodpecker is a community fork of the Drone CI system.

Usage

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

Documentation

https://woodpecker-ci.github.io/

Who uses Woodpecker?

Currently, I know of one organization using Woodpecker. With 50+ users, 130+ repos and more than 1100 builds a week.

Contribution

See Contributing Guide

License

Woodpecker is Apache 2.0 licensed with the source files in this repository having a header indicating which license they are under and what copyrights apply.

Files under the docs/ folder are licensed under Creative Commons Attribution-ShareAlike 4.0 International Public License.

3.7 KiB Raw Blame History