mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-11-27 04:11:03 +00:00
103 lines
2.5 KiB
Markdown
103 lines
2.5 KiB
Markdown
# Woodpecker
|
|
|
|
An opinionated fork of the Drone CI system.
|
|
|
|
- Based on the v0.8 code tree
|
|
- Focused on team usage
|
|
- Fully Apache 2.0, no tiers
|
|
|
|
[](https://goreportcard.com/report/github.com/laszlocph/woodpecker) [](https://opensource.org/licenses/Apache-2.0)
|
|
|
|
|
|
|
|
## .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
|
|
|
|
```yaml
|
|
# .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
|
|
|
|
```diff
|
|
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
|
|
|
|
```yaml
|
|
# .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
|
|
# Dockerfile
|
|
FROM laszlocloud/kubectl
|
|
COPY deploy /usr/local/deploy
|
|
ENTRYPOINT ["/usr/local/deploy"]
|
|
```
|
|
|
|
```bash
|
|
# deploy
|
|
kubectl apply -f $PLUGIN_TEMPLATE
|
|
```
|
|
|
|
```yaml
|
|
# .woodpecker.yml
|
|
pipeline:
|
|
deploy-to-k8s:
|
|
image: laszlocloud/my-k8s-plugin
|
|
template: config/k8s/service.yml
|
|
```
|
|
|
|
## Documentation
|
|
|
|
https://woodpecker.laszlo.cloud
|
|
|
|
## Who uses Woodpecker
|
|
|
|
Currently I know of one organization using this fork. With 50+ users, 130+ repos and more than 1100 builds a week.
|
|
|
|
## 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 is licensed under Creative Commons Attribution-ShareAlike 4.0 International Public License. It is a derivative work of the https://github.com/drone/docs git repository.
|