woodpecker/README.md

142 lines
4 KiB
Markdown
Raw Normal View History

<p align="center">
<a href="https://github.com/woodpecker-ci/woodpecker/">
<img alt="Woodpecker" src="https://raw.githubusercontent.com/woodpecker-ci/woodpecker/master/docs/static/img/logo.svg" width="220"/>
</a>
</p>
<br/>
<p align="center">
<a href="https://wp.laszlo.cloud/woodpecker-ci/woodpecker" title="Build Status">
<img src="https://wp.laszlo.cloud/api/badges/woodpecker-ci/woodpecker/status.svg">
</a>
<a href="https://discord.gg/fcMQqSMXJy" title="Join the Discord chat at https://discord.gg/fcMQqSMXJy">
<img src="https://img.shields.io/discord/838698813463724034.svg">
</a>
<a href="https://goreportcard.com/badge/github.com/woodpecker-ci/woodpecker" title="Go Report Card">
<img src="https://goreportcard.com/badge/github.com/woodpecker-ci/woodpecker">
</a>
<a href="https://godoc.org/github.com/woodpecker-ci/woodpecker" title="GoDoc">
<img src="https://godoc.org/github.com/woodpecker-ci/woodpecker?status.svg">
</a>
<a href="https://github.com/woodpecker-ci/woodpecker/releases/latest" title="GitHub release">
<img src="https://img.shields.io/github/v/release/woodpecker-ci/woodpecker?sort=semver">
</a>
<a href="https://hub.docker.com/r/woodpeckerci/woodpecker-server" title="Docker pulls">
<img src="https://img.shields.io/docker/pulls/woodpeckerci/woodpecker-server">
</a>
<a href="https://opensource.org/licenses/Apache-2.0" title="License: Apache-2.0">
<img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg">
</a>
</p>
<br/>
2019-06-04 07:37:15 +00:00
# Woodpecker
2019-06-04 07:37:15 +00:00
> Woodpecker is a community fork of the Drone CI system.
2019-06-04 07:37:15 +00:00
![woodpecker](docs/docs/woodpecker.png)
2019-06-04 07:37:15 +00:00
## Support
Please consider to donate and become a backer. 🙏 [[Become a backer](https://opencollective.com/woodpecker-ci#category-CONTRIBUTE)]
<a href="https://opencollective.com/woodpecker-ci" target="_blank"><img src="https://opencollective.com/woodpecker-ci/backers.svg?width=890"></a>
## Usage
2019-06-04 07:37:15 +00:00
### .woodpecker.yml
- Place your pipeline in a file named `.woodpecker.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
# .woodpecker.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.."
```
### 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:
2019-11-15 10:13:16 +00:00
- image: debian
+ image: mycompany/image-with-awscli
commands:
- aws help
2019-11-15 10:13:16 +00:00
```
2019-07-05 13:30:25 +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
# .woodpecker.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
```
### Plugins are straightforward
2019-11-15 10:13:16 +00:00
- 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
# .woodpecker.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
https://woodpecker-ci.org/
2019-07-05 13:30:25 +00:00
## Who uses Woodpecker?
2019-07-05 13:30:25 +00:00
2021-07-20 21:20:35 +00:00
Currently, I know of one organization using Woodpecker. With 50+ users, 130+ repos and more than 1100 builds a week.
2021-02-19 08:57:34 +00:00
Leave a [comment](https://github.com/woodpecker-ci/woodpecker/issues/122) if you're using it.
2019-07-05 13:30:25 +00:00
## Contribution
See [Contributing Guide](CONTRIBUTING.md)
2019-07-05 13:30:25 +00:00
## License
2021-07-20 21:20:35 +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 are licensed under Creative Commons Attribution-ShareAlike 4.0 International Public License.