woodpecker/README.md

105 lines
2.5 KiB
Markdown
Raw Normal View History

2019-07-25 11:13:13 +00:00
# Woodpecker
2019-06-04 07:37:15 +00:00
2021-03-08 07:41:58 +00:00
A fork of the Drone CI system.
2019-06-04 07:37:15 +00:00
2019-07-05 13:30:25 +00:00
- Based on the v0.8 code tree
2019-11-15 10:13:16 +00:00
- Fully Apache 2.0, no tiers
2019-06-04 07:37:15 +00:00
[![Go Report Card](https://goreportcard.com/badge/github.com/laszlocph/woodpecker)](https://goreportcard.com/report/github.com/laszlocph/woodpecker) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
2019-06-04 07:37:15 +00:00
2019-11-15 10:13:16 +00:00
![woodpecker](docs/docs/images/woodpecker.png)
2019-06-04 07:37:15 +00:00
2021-02-16 12:56:54 +00:00
## .drone.yml
2019-06-04 07:37:15 +00:00
2021-02-16 12:56:54 +00:00
- Place your pipeline in a file named `.drone.yml` in your repository
2019-11-15 10:13:16 +00:00
- Pipeline steps can be named as you like
- Run any command in the commands section
2019-07-05 13:30:25 +00:00
```yaml
2021-02-16 12:56:54 +00:00
# .drone.yml
2019-07-05 13:30:25 +00:00
pipeline:
build:
2019-11-15 10:13:16 +00:00
image: debian
2019-07-05 13:30:25 +00:00
commands:
- echo "This is the build step"
a-test-step:
2019-11-15 10:13:16 +00:00
image: debian
2019-07-05 13:30:25 +00:00
commands:
- echo "Testing.."
```
2019-11-15 10:13:16 +00:00
## Build steps are containers
2019-07-05 13:30:25 +00:00
2019-11-15 10:13:16 +00:00
- Define any Docker image as context
- Install the needed tools in custom Docker images, use them as context
2019-07-05 13:30:25 +00:00
2019-11-15 10:13:16 +00:00
```diff
pipeline:
build:
- image: debian
+ image: mycompany/image-with-awscli
commands:
- aws help
```
2019-07-05 13:30:25 +00:00
2019-11-15 10:13:16 +00:00
## File changes are incremental
2019-07-05 13:30:25 +00:00
2019-11-15 10:13:16 +00:00
- 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
2019-07-05 13:30:25 +00:00
```yaml
2021-02-16 12:56:54 +00:00
# .drone.yml
2019-07-05 13:30:25 +00:00
pipeline:
2019-11-15 10:13:16 +00:00
build:
image: debian
2019-07-05 13:30:25 +00:00
commands:
2019-11-15 10:13:16 +00:00
- touch myfile
a-test-step:
image: debian
commands:
- cat myfile
2019-07-05 13:30:25 +00:00
```
2019-11-15 10:13:16 +00:00
## 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
2019-07-05 13:30:25 +00:00
2019-11-15 10:13:16 +00:00
```Dockerfile
# Dockerfile
FROM laszlocloud/kubectl
COPY deploy /usr/local/deploy
ENTRYPOINT ["/usr/local/deploy"]
```
2019-07-05 13:30:25 +00:00
2019-11-15 10:13:16 +00:00
```bash
# deploy
kubectl apply -f $PLUGIN_TEMPLATE
```
2019-07-05 13:30:25 +00:00
2019-11-15 10:13:16 +00:00
```yaml
2021-02-16 12:56:54 +00:00
# .drone.yml
2019-11-15 10:13:16 +00:00
pipeline:
deploy-to-k8s:
image: laszlocloud/my-k8s-plugin
template: config/k8s/service.yml
```
2019-07-05 13:30:25 +00:00
2019-11-15 10:13:16 +00:00
## Documentation
2019-07-05 13:30:25 +00:00
2019-11-15 10:13:16 +00:00
https://woodpecker.laszlo.cloud
2019-07-05 13:30:25 +00:00
2019-11-15 10:13:16 +00:00
## Who uses Woodpecker
2019-07-05 13:30:25 +00:00
2021-02-19 08:57:34 +00:00
Currently, I know of one organization using this fork. With 50+ users, 130+ repos and more than 1100 builds a week.
Leave a note here if you are using it: https://github.com/laszlocph/woodpecker/issues/122
2019-07-05 13:30:25 +00:00
## License
2019-08-27 11:01:29 +00:00
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.
2019-07-05 13:30:25 +00:00
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.