2021-09-11 21:45:18 +00:00
< p align = "center" >
< a href = "https://github.com/woodpecker-ci/woodpecker/" >
2022-09-25 17:04:47 +00:00
< img alt = "Woodpecker" src = "docs/static/img/logo.svg" width = "220" / >
2021-09-11 21:45:18 +00:00
< / a >
< / p >
< br / >
< p align = "center" >
2021-12-03 14:36:22 +00:00
< a href = "https://ci.woodpecker-ci.org/woodpecker-ci/woodpecker" title = "Build Status" >
< img src = "https://ci.woodpecker-ci.org/api/badges/woodpecker-ci/woodpecker/status.svg" >
2021-09-11 21:45:18 +00:00
< / a >
2022-02-01 18:34:56 +00:00
< a href = "https://codecov.io/gh/woodpecker-ci/woodpecker" >
2023-07-31 03:47:23 +00:00
< img src = "https://codecov.io/gh/woodpecker-ci/woodpecker/branch/main/graph/badge.svg" / >
2022-02-01 18:34:56 +00:00
< / a >
2022-09-04 07:37:27 +00:00
< a href = "https://translate.woodpecker-ci.org/engage/woodpecker-ci/" >
< img src = "https://translate.woodpecker-ci.org/widgets/woodpecker-ci/-/ui/svg-badge.svg" alt = "Translation status" / >
< / a >
2021-09-11 21:45:18 +00:00
< a href = "https://discord.gg/fcMQqSMXJy" title = "Join the Discord chat at https://discord.gg/fcMQqSMXJy" >
2021-12-30 17:53:52 +00:00
< img src = "https://img.shields.io/discord/838698813463724034.svg?label=discord" >
< / a >
< a href = "https://matrix.to/#/#woodpecker:matrix.org" title = "Join the Matrix space at https://matrix.to/#/#woodpecker:matrix.org" >
< img src = "https://img.shields.io/matrix/woodpecker:matrix.org?label=matrix" >
2021-09-11 21:45:18 +00:00
< / 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 >
2022-09-01 00:58:43 +00:00
< a href = "https://bestpractices.coreinfrastructure.org/projects/5309" >
< img src = "https://bestpractices.coreinfrastructure.org/projects/5309/badge" >
< / a >
2022-01-31 13:40:44 +00:00
< a href = "https://www.tickgit.com/browse?repo=github.com/woodpecker-ci/woodpecker" title = "TODOs" >
< img src = "https://badgen.net/https/api.tickgit.com/badgen/github.com/woodpecker-ci/woodpecker" >
< / a >
2021-09-11 21:45:18 +00:00
< / p >
< br / >
2019-06-04 07:37:15 +00:00
2021-09-11 21:45:18 +00:00
# Woodpecker
2019-06-04 07:37:15 +00:00
2021-09-11 21:45:18 +00:00
> Woodpecker is a community fork of the Drone CI system.
2019-06-04 07:37:15 +00:00
2021-09-11 16:48:52 +00:00
![woodpecker ](docs/docs/woodpecker.png )
2019-06-04 07:37:15 +00:00
2022-07-31 15:07:18 +00:00
## 🫶 Support
2021-09-17 16:34:11 +00:00
Please consider to donate and become a backer. 🙏 [[Become a backer ](https://opencollective.com/woodpecker-ci#category-CONTRIBUTE )]
2022-07-31 15:07:18 +00:00
2021-09-17 16:34:11 +00:00
< a href = "https://opencollective.com/woodpecker-ci" target = "_blank" > < img src = "https://opencollective.com/woodpecker-ci/backers.svg?width=890" > < / a >
2022-07-31 15:07:18 +00:00
## 🚀 Usage
2019-06-04 07:37:15 +00:00
2021-09-11 21:45:18 +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
2021-12-03 14:36:22 +00:00
[Read More ](https://woodpecker-ci.org/docs/usage/intro )
2019-07-05 13:30:25 +00:00
2021-09-11 21:45:18 +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
2021-12-03 14:36:22 +00:00
[Read More ](https://woodpecker-ci.org/docs/usage/pipeline-syntax#steps )
### Plugins
Woodpecker has [official plugins ](https://woodpecker-ci.org/plugins ), but you can also use your own.
[Read More ](https://woodpecker-ci.org/docs/usage/plugins/plugins )
2019-07-05 13:30:25 +00:00
2022-07-31 15:07:18 +00:00
## 📖 Documentation
2019-07-05 13:30:25 +00:00
2021-10-14 16:13:57 +00:00
https://woodpecker-ci.org/
2019-07-05 13:30:25 +00:00
2022-07-31 15:07:18 +00:00
## ✨ Contribute
2021-12-03 14:36:22 +00:00
See [Contributing Guide ](CONTRIBUTING.md )
2022-10-01 11:54:19 +00:00
[![Open in Gitpod ](https://gitpod.io/button/open-in-gitpod.svg )](https://woodpecker-ci.org/docs/next/development/getting-started#gitpod)
2022-07-31 15:07:18 +00:00
2022-09-04 07:37:27 +00:00
## 📣 Translate
2022-09-07 16:36:48 +00:00
We use an own [Weblate ](https://weblate.org/en/ ) instance at [translate.woodpecker-ci.org ](https://translate.woodpecker-ci.org ).
2022-09-04 07:37:27 +00:00
< a href = "https://translate.woodpecker-ci.org/engage/woodpecker-ci/" >
< img src = "https://translate.woodpecker-ci.org/widgets/woodpecker-ci/-/ui/multi-blue.svg" alt = "Translation status" / >
< / a >
2022-07-31 15:07:18 +00:00
## 👋 Who uses Woodpecker?
2019-07-05 13:30:25 +00:00
2022-07-31 15:07:18 +00:00
[Codeberg ](https://codeberg.org ), the Woodpecker project itself, and many others.
2021-02-19 08:57:34 +00:00
2022-07-31 15:07:18 +00:00
Leave a [comment ](https://github.com/woodpecker-ci/woodpecker/issues/122 ) if you're using it as well.
2019-07-05 13:30:25 +00:00
2022-07-31 15:07:18 +00:00
Also consider using the topic `WoodpeckerCI` in your repository, so others can learn from your config and use the hashtag `#WoodpeckerCI` when talking about the project on social media!
2022-01-05 22:32:04 +00:00
Here are some places where people mention Woodpecker:
- [GitHub ](https://github.com/topics/WoodpeckerCI )
- [Codeberg ](https://codeberg.org/explore/repos?q=woodpeckerci&topic=1 )
2023-04-30 19:54:38 +00:00
- [Twitter ](https://twitter.com/search?q=%23WoodpeckerCI&src=typed_query )
2022-01-05 22:32:04 +00:00
- [Fediverse ](https://mastodon.social/tags/WoodpeckerCI )
2022-07-31 15:07:18 +00:00
## ✨ Stars over time
2021-12-03 14:36:22 +00:00
[![Stargazers over time ](https://starchart.cc/woodpecker-ci/woodpecker.svg )](https://starchart.cc/woodpecker-ci/woodpecker)
2021-09-11 21:45:18 +00:00
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
2021-09-11 21:45:18 +00:00
Files under the `docs/` folder are licensed under Creative Commons Attribution-ShareAlike 4.0 International Public License.