2023-10-31 08:14:09 +00:00
# Woodpecker
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" >
2024-04-29 19:33:45 +00:00
< a href = "https://ci.woodpecker-ci.org/repos/3780" title = "Pipeline Status" >
< img src = "https://ci.woodpecker-ci.org/api/badges/3780/status.svg" alt = "Pipeline Status" >
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" >
2024-01-01 19:14:12 +00:00
< img src = "https://codecov.io/gh/woodpecker-ci/woodpecker/branch/main/graph/badge.svg" alt = "Code coverage" >
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-12-30 17:53:52 +00:00
< a href = "https://matrix.to/#/#woodpecker:matrix.org" title = "Join the Matrix space at https://matrix.to/#/#woodpecker:matrix.org" >
2024-01-01 19:14:12 +00:00
< img src = "https://img.shields.io/matrix/woodpecker:matrix.org?label=matrix" alt = "Matrix space" >
2021-09-11 21:45:18 +00:00
< / a >
2023-12-27 09:05:13 +00:00
< a href = "https://goreportcard.com/report/go.woodpecker-ci.org/woodpecker/v2" title = "Go Report Card" >
2024-01-01 19:14:12 +00:00
< img src = "https://goreportcard.com/badge/go.woodpecker-ci.org/woodpecker/v2" alt = "Go Report Card" >
2021-09-11 21:45:18 +00:00
< / a >
2023-12-26 20:52:44 +00:00
< a href = "https://pkg.go.dev/go.woodpecker-ci.org/woodpecker/v2" title = "go reference" >
2024-01-01 19:14:12 +00:00
< img src = "https://pkg.go.dev/badge/go.woodpecker-ci.org/woodpecker/v2" alt = "go reference" >
2021-09-11 21:45:18 +00:00
< / a >
< a href = "https://github.com/woodpecker-ci/woodpecker/releases/latest" title = "GitHub release" >
2024-01-01 19:14:12 +00:00
< img src = "https://img.shields.io/github/v/release/woodpecker-ci/woodpecker?sort=semver" alt = "GitHub release" >
2021-09-11 21:45:18 +00:00
< / a >
< a href = "https://hub.docker.com/r/woodpeckerci/woodpecker-server" title = "Docker pulls" >
2024-01-01 19:14:12 +00:00
< img src = "https://img.shields.io/docker/pulls/woodpeckerci/woodpecker-server" alt = "Docker pulls" >
2021-09-11 21:45:18 +00:00
< / a >
< a href = "https://opensource.org/licenses/Apache-2.0" title = "License: Apache-2.0" >
2024-01-01 19:14:12 +00:00
< img src = "https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt = "License: Apache-2.0" >
2021-09-11 21:45:18 +00:00
< / a >
2022-09-01 00:58:43 +00:00
< a href = "https://bestpractices.coreinfrastructure.org/projects/5309" >
2024-01-27 20:15:10 +00:00
< img src = "https://bestpractices.coreinfrastructure.org/projects/5309/badge" alt = "OpenSSF best practices" >
2022-09-01 00:58:43 +00:00
< / a >
2023-12-16 08:45:02 +00:00
< a href = "https://results.pre-commit.ci/repo/github/179344069" title = "pre-commit.ci" >
2024-01-01 19:14:12 +00:00
< img src = "https://results.pre-commit.ci/badge/github/woodpecker-ci/woodpecker/main.svg" alt = "pre-commit.ci" >
2023-10-31 08:14:09 +00:00
< / a >
2021-09-11 21:45:18 +00:00
< / p >
< br / >
2019-06-04 07:37:15 +00:00
2024-08-04 23:27:25 +00:00
Woodpecker is a simple, yet powerful CI/CD engine with great extensibility.
2019-06-04 07:37:15 +00:00
2024-08-11 08:26:26 +00:00
![woodpecker ](docs/woodpecker.png )
2019-06-04 07:37:15 +00:00
2024-08-04 23:27:25 +00:00
## Installation & Resources
2021-09-17 16:34:11 +00:00
2024-08-11 08:26:26 +00:00
Woodpecker can be installed in various ways (see the [Installation Instructions ](https://woodpecker-ci.org/docs/administration/getting-started )) and runs with SQLite as database by default.
2024-08-04 23:27:25 +00:00
It requires around 100 MB of RAM (Server) and 30 MB (Agent) at runtime in idle mode.
2022-07-31 15:07:18 +00:00
2024-08-04 23:27:25 +00:00
## Support
2019-07-05 13:30:25 +00:00
2024-08-04 23:27:25 +00:00
You can support the project by becoming a backer on [Open Collective ](https://opencollective.com/woodpecker-ci#category-CONTRIBUTE ) or via [GitHub Sponsors ](https://github.com/sponsors/woodpecker-ci ).
2019-07-05 13:30:25 +00:00
2024-08-04 23:27:25 +00:00
< a href = "https://opencollective.com/woodpecker-ci" target = "_blank" > < img src = "https://opencollective.com/woodpecker-ci/backers.svg?width=890" alt = "Open Collective backers" > < / a >
2021-12-03 14:36:22 +00:00
2024-08-04 23:27:25 +00:00
## Documentation
2022-07-31 15:07:18 +00:00
2024-08-11 08:26:26 +00:00
Our documentation can be found at < https: / / woodpecker-ci . org / docs / intro > .
2022-09-04 07:37:27 +00:00
2024-08-04 23:27:25 +00:00
## Translation
2022-09-04 07:37:27 +00:00
2024-08-04 23:27:25 +00:00
We have a self-hosted [Weblate ](https://weblate.org/en/ ) instance at [translate.woodpecker-ci.org ](https://translate.woodpecker-ci.org ).
2022-09-04 07:37:27 +00:00
2024-08-04 23:27:25 +00:00
An overview of the current translation state is available at < https: / / translate . woodpecker-ci . org / projects / woodpecker-ci / # languages > .
2019-07-05 13:30:25 +00:00
2024-08-04 23:27:25 +00:00
## Public Woodpecker Instances
2019-07-05 13:30:25 +00:00
2024-08-04 23:27:25 +00:00
Woodpecker is used as the main CI/CD engine at [Codeberg ](https://codeberg.org ), an alternative Git hosting platform with a focus on privacy and free software development.
2022-01-05 22:32:04 +00:00
2024-08-04 23:27:25 +00:00
## Plugins
2022-01-05 22:32:04 +00:00
2024-08-04 23:27:25 +00:00
Woodpecker can be extended via plugins.
The [plugin overview website ](https://woodpecker-ci.org/plugins ) helps browsing available plugins.
It combines both plugins by the Woodpecker core team and community-maintained ones.
2022-01-05 22:32:04 +00:00
2024-08-04 23:27:25 +00:00
## Star History
2022-07-31 15:07:18 +00:00
2024-08-04 23:27:25 +00:00
[![Star History Chart ](https://api.star-history.com/svg?repos=woodpecker-ci/woodpecker&type=Date )](https://star-history.com/#woodpecker-ci/woodpecker& Date)
2021-09-11 21:45:18 +00:00
2019-07-05 13:30:25 +00:00
## License
2024-08-04 23:27:25 +00:00
Woodpecker is Apache 2.0 licensed.
The source files have a header indicating which license they are under and what copyrights apply.
2019-07-05 13:30:25 +00:00
2024-08-04 23:27:25 +00:00
Everything in `docs/` is licensed under the Creative Commons Attribution-ShareAlike 4.0 International Public License.