mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-11-30 08:06:52 +02:00
Woodpecker is a simple yet powerful CI/CD engine with great extensibility.
.github | ||
.vscode | ||
.woodpecker | ||
charts | ||
cli | ||
cmd | ||
cncd | ||
docs | ||
drone-go | ||
model | ||
plugins | ||
remote | ||
server | ||
shared | ||
store | ||
vendor | ||
version | ||
web | ||
.changelog.yml | ||
.dockerignore | ||
.editorconfig | ||
.gitignore | ||
BUILDING | ||
CHANGELOG.md | ||
CONTRIBUTING.md | ||
docker-compose.example.yml | ||
Dockerfile | ||
Dockerfile.agent | ||
Dockerfile.agent.alpine | ||
Dockerfile.alpine | ||
go.mod | ||
go.sum | ||
LICENSE | ||
Makefile | ||
README.md | ||
tools.go |
Woodpecker
Woodpecker is a community fork of the Drone CI system.
Support
Please consider to donate and become a backer. 🙏 [Become a backer]
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.
Leave a comment if you're using it.
Contribution
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.