woodpecker/README.md

# Woodpecker

<p align="center">
  <a href="https://github.com/woodpecker-ci/woodpecker/">
    <img alt="Woodpecker" src="docs/static/img/logo.svg" width="220"/>
  </a>
</p>
<br/>
<p align="center">
  <a href="https://ci.woodpecker-ci.org/repos/3780" title="Build Status">
    <img src="https://ci.woodpecker-ci.org/api/badges/3780/status.svg">
  </a>
  <a href="https://codecov.io/gh/woodpecker-ci/woodpecker">
    <img src="https://codecov.io/gh/woodpecker-ci/woodpecker/branch/main/graph/badge.svg"/>
  </a>
  <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>
  <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?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">
  </a>
  <a href="https://goreportcard.com/report/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>
  <a href="https://bestpractices.coreinfrastructure.org/projects/5309">
    <img src="https://bestpractices.coreinfrastructure.org/projects/5309/badge">
  </a>
  <a href="https://results.pre-commit.ci/repo/github/179344069" title="pre-commit.ci">
    <img src="https://results.pre-commit.ci/badge/github/woodpecker-ci/woodpecker/main.svg">
  </a>
</p>
<br/>

Woodpecker is a simple yet powerful CI/CD engine with great extensibility.

![woodpecker](docs/docs/woodpecker.png)

## 🫶 Support

Please consider donating 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>

## 📖 Documentation

<https://woodpecker-ci.org/>

## ✨ Contribute

See [Contributing Guide](CONTRIBUTING.md)

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://woodpecker-ci.org/docs/next/development/getting-started#gitpod)

## 📣 Translate

We use an own [Weblate](https://weblate.org/en/) instance at [translate.woodpecker-ci.org](https://translate.woodpecker-ci.org).

<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>

## 👋 Who uses Woodpecker?

Woodpecker is used by [itself](https://ci.woodpecker-ci.org/woodpecker/woodpecker-ci/) multiple well-known companies, organizations like [Codeberg](https://codeberg.org), hobbyist and many others.

Leave a [comment](https://github.com/woodpecker-ci/woodpecker/discussions/2149) if you're using it as well.

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!

Here are some places where people mention Woodpecker:

- [GitHub](https://github.com/topics/WoodpeckerCI)
- [Codeberg](https://codeberg.org/explore/repos?q=woodpeckerci&topic=1)
- [Twitter](https://twitter.com/search?q=%23WoodpeckerCI&src=typed_query)
- [Fediverse](https://mastodon.social/tags/WoodpeckerCI)

## ✨ Stars over time

[![Stargazers over time](https://starchart.cc/woodpecker-ci/woodpecker.svg)](https://starchart.cc/woodpecker-ci/woodpecker)

## 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 are licensed under Creative Commons Attribution-ShareAlike 4.0 International Public License.
`pre-commit` fixes (#2669) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Anbraten <anton@ju60.de> 2023-10-31 08:14:09 +00:00			`# Woodpecker`

Community Guide (#296) Add a Community-Guide template was taken from [gitea](https://github.com/go-gitea/gitea/blob/main/CONTRIBUTING.md) Signed-off-by: 6543 <6543@obermui.de> Co-authored-by: Anbraten <anton@ju60.de> Co-authored-by: Malachi Soord <inverse.chi@gmail.com> 2021-09-11 21:45:18 +00:00			`<p align="center">`
			`<a href="https://github.com/woodpecker-ci/woodpecker/">`
Improve plugins index (#1200) Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com> 2022-09-25 17:04:47 +00:00			`<img alt="Woodpecker" src="docs/static/img/logo.svg" width="220"/>`
Community Guide (#296) Add a Community-Guide template was taken from [gitea](https://github.com/go-gitea/gitea/blob/main/CONTRIBUTING.md) Signed-off-by: 6543 <6543@obermui.de> Co-authored-by: Anbraten <anton@ju60.de> Co-authored-by: Malachi Soord <inverse.chi@gmail.com> 2021-09-11 21:45:18 +00:00			`</a>`
			`</p>`
			`<br/>`
			`<p align="center">`
Update README badges (#2956) - use repo id - remove tickgit (the service is broken) - use dynamic pre-commit.ci badge 2023-12-16 08:45:02 +00:00			`<a href="https://ci.woodpecker-ci.org/repos/3780" title="Build Status">`
			`<img src="https://ci.woodpecker-ci.org/api/badges/3780/status.svg">`
Community Guide (#296) Add a Community-Guide template was taken from [gitea](https://github.com/go-gitea/gitea/blob/main/CONTRIBUTING.md) Signed-off-by: 6543 <6543@obermui.de> Co-authored-by: Anbraten <anton@ju60.de> Co-authored-by: Malachi Soord <inverse.chi@gmail.com> 2021-09-11 21:45:18 +00:00			`</a>`
Add Codecov.io Upload (#660) use https://github.com/woodpecker-ci/plugin-codecov to track code coverage on codecov.io 2022-02-01 18:34:56 +00:00			`<a href="https://codecov.io/gh/woodpecker-ci/woodpecker">`
Change master to main (#2044) 2023-07-31 03:47:23 +00:00			`<img src="https://codecov.io/gh/woodpecker-ci/woodpecker/branch/main/graph/badge.svg"/>`
Add Codecov.io Upload (#660) use https://github.com/woodpecker-ci/plugin-codecov to track code coverage on codecov.io 2022-02-01 18:34:56 +00:00			`</a>`
Add Translation Platform to Docs (#1168) close #1164 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>`
Community Guide (#296) Add a Community-Guide template was taken from [gitea](https://github.com/go-gitea/gitea/blob/main/CONTRIBUTING.md) Signed-off-by: 6543 <6543@obermui.de> Co-authored-by: Anbraten <anton@ju60.de> Co-authored-by: Malachi Soord <inverse.chi@gmail.com> 2021-09-11 21:45:18 +00:00			`<a href="https://discord.gg/fcMQqSMXJy" title="Join the Discord chat at https://discord.gg/fcMQqSMXJy">`
Mention Matrix Space & Rooms in Readme & Docs (#646) * Mention Matrix Space & Rooms in Readme & Docs * custom labels Co-authored-by: John Olheiser <john.olheiser@gmail.com> Co-authored-by: John Olheiser <john.olheiser@gmail.com> 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">`
Community Guide (#296) Add a Community-Guide template was taken from [gitea](https://github.com/go-gitea/gitea/blob/main/CONTRIBUTING.md) Signed-off-by: 6543 <6543@obermui.de> Co-authored-by: Anbraten <anton@ju60.de> Co-authored-by: Malachi Soord <inverse.chi@gmail.com> 2021-09-11 21:45:18 +00:00			`</a>`
Update README badge link (#2596) previous link was useless as it just points to the badge itself 2023-10-16 21:16:41 +00:00			`<a href="https://goreportcard.com/report/github.com/woodpecker-ci/woodpecker" title="Go Report Card">`
Community Guide (#296) Add a Community-Guide template was taken from [gitea](https://github.com/go-gitea/gitea/blob/main/CONTRIBUTING.md) Signed-off-by: 6543 <6543@obermui.de> Co-authored-by: Anbraten <anton@ju60.de> Co-authored-by: Malachi Soord <inverse.chi@gmail.com> 2021-09-11 21:45:18 +00:00			`<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>`
Add OpenSSF BP Badge (#1147) close #765 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>`
Update README badges (#2956) - use repo id - remove tickgit (the service is broken) - use dynamic pre-commit.ci badge 2023-12-16 08:45:02 +00:00			`<a href="https://results.pre-commit.ci/repo/github/179344069" title="pre-commit.ci">`
			`<img src="https://results.pre-commit.ci/badge/github/woodpecker-ci/woodpecker/main.svg">`
`pre-commit` fixes (#2669) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Anbraten <anton@ju60.de> 2023-10-31 08:14:09 +00:00			`</a>`
Community Guide (#296) Add a Community-Guide template was taken from [gitea](https://github.com/go-gitea/gitea/blob/main/CONTRIBUTING.md) Signed-off-by: 6543 <6543@obermui.de> Co-authored-by: Anbraten <anton@ju60.de> Co-authored-by: Malachi Soord <inverse.chi@gmail.com> 2021-09-11 21:45:18 +00:00			`</p>`
			`<br/>`
Some info on the project 2019-06-04 07:37:15 +00:00
Update slogan & logo (#2962) - Update woodpecker slogan to repo too we are not just a simple fork anymore 🎉 - use https://github.com/woodpecker-ci/design/blob/main/logo/non-square.svg 2023-12-19 13:12:18 +00:00			`Woodpecker is a simple yet powerful CI/CD engine with great extensibility.`
Some info on the project 2019-06-04 07:37:15 +00:00
[CI] Fix docs deploy & links (#301) * set git commiter * update links to docu * fix image link 2021-09-11 16:48:52 +00:00			`![woodpecker](docs/docs/woodpecker.png)`
Some info on the project 2019-06-04 07:37:15 +00:00
Add gitpod setup (#1020) Adding [Gitpod](https://github.com/gitpod-io/gitpod) allows us and others to easily start a complete Woodpecker setup and development cloud IDE. It starts a Woodpecker server, agent and a preconfigured Gitea instance. You can login at Gitea with `woodpecker` and `password`. 2022-07-31 15:07:18 +00:00			`## 🫶 Support`
Add Support section to README (#310) * Add Support section to README * Add funding config for GitHub Co-authored-by: Anbraten <anton@ju60.de> 2021-09-17 16:34:11 +00:00
Update slogan & logo (#2962) - Update woodpecker slogan to repo too we are not just a simple fork anymore 🎉 - use https://github.com/woodpecker-ci/design/blob/main/logo/non-square.svg 2023-12-19 13:12:18 +00:00			`Please consider donating and become a backer. 🙏 [[Become a backer](https://opencollective.com/woodpecker-ci#category-CONTRIBUTE)]`
Add gitpod setup (#1020) Adding [Gitpod](https://github.com/gitpod-io/gitpod) allows us and others to easily start a complete Woodpecker setup and development cloud IDE. It starts a Woodpecker server, agent and a preconfigured Gitea instance. You can login at Gitea with `woodpecker` and `password`. 2022-07-31 15:07:18 +00:00
Add Support section to README (#310) * Add Support section to README * Add funding config for GitHub Co-authored-by: Anbraten <anton@ju60.de> 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>`

Add gitpod setup (#1020) Adding [Gitpod](https://github.com/gitpod-io/gitpod) allows us and others to easily start a complete Woodpecker setup and development cloud IDE. It starts a Woodpecker server, agent and a preconfigured Gitea instance. You can login at Gitea with `woodpecker` and `password`. 2022-07-31 15:07:18 +00:00			`## 📖 Documentation`
Readme 2019-07-05 13:30:25 +00:00
`pre-commit` fixes (#2669) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Anbraten <anton@ju60.de> 2023-10-31 08:14:09 +00:00			`<https://woodpecker-ci.org/>`
Readme 2019-07-05 13:30:25 +00:00
Add gitpod setup (#1020) Adding [Gitpod](https://github.com/gitpod-io/gitpod) allows us and others to easily start a complete Woodpecker setup and development cloud IDE. It starts a Woodpecker server, agent and a preconfigured Gitea instance. You can login at Gitea with `woodpecker` and `password`. 2022-07-31 15:07:18 +00:00			`## ✨ Contribute`
Update README (#560) * Add "Stars over time to README * Move info from README into docs & link to it * New CI location * New screenshot Co-authored-by: John Olheiser <john.olheiser@gmail.com> 2021-12-03 14:36:22 +00:00
			`See [Contributing Guide](CONTRIBUTING.md)`

Fix gitpod link (#1228) 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)`
Add gitpod setup (#1020) Adding [Gitpod](https://github.com/gitpod-io/gitpod) allows us and others to easily start a complete Woodpecker setup and development cloud IDE. It starts a Woodpecker server, agent and a preconfigured Gitea instance. You can login at Gitea with `woodpecker` and `password`. 2022-07-31 15:07:18 +00:00
Add Translation Platform to Docs (#1168) close #1164 2022-09-04 07:37:27 +00:00			`## 📣 Translate`

Fix readme grammar and increase golangci-lint timeout (#1173) 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).`
Add Translation Platform to Docs (#1168) close #1164 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>`

Add gitpod setup (#1020) Adding [Gitpod](https://github.com/gitpod-io/gitpod) allows us and others to easily start a complete Woodpecker setup and development cloud IDE. It starts a Woodpecker server, agent and a preconfigured Gitea instance. You can login at Gitea with `woodpecker` and `password`. 2022-07-31 15:07:18 +00:00			`## 👋 Who uses Woodpecker?`
Readme 2019-07-05 13:30:25 +00:00
Cleanup docs (#2478) Co-authored-by: Robert Kaussow <xoxys@rknet.org> 2023-10-17 08:31:08 +00:00			`Woodpecker is used by [itself](https://ci.woodpecker-ci.org/woodpecker/woodpecker-ci/) multiple well-known companies, organizations like [Codeberg](https://codeberg.org), hobbyist and many others.`
Fixing tests 2021-02-19 08:57:34 +00:00
Cleanup docs (#2478) Co-authored-by: Robert Kaussow <xoxys@rknet.org> 2023-10-17 08:31:08 +00:00			`Leave a [comment](https://github.com/woodpecker-ci/woodpecker/discussions/2149) if you're using it as well.`
Readme 2019-07-05 13:30:25 +00:00
Add gitpod setup (#1020) Adding [Gitpod](https://github.com/gitpod-io/gitpod) allows us and others to easily start a complete Woodpecker setup and development cloud IDE. It starts a Woodpecker server, agent and a preconfigured Gitea instance. You can login at Gitea with `woodpecker` and `password`. 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!
Add WoodpeckerCI tag to README (#663) This way people can mention the project and find other project who use it. 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)`
docs: change broken twitter url (#1729) Looks like the Twitter URL has changed and `https://twitter.com/hashtag/WoodpeckerCI?f=live` no longer works Signed-off-by: Alexander Matyushentsev <AMatyushentsev@gmail.com> 2023-04-30 19:54:38 +00:00			`- [Twitter](https://twitter.com/search?q=%23WoodpeckerCI&src=typed_query)`
Add WoodpeckerCI tag to README (#663) This way people can mention the project and find other project who use it. 2022-01-05 22:32:04 +00:00			`- [Fediverse](https://mastodon.social/tags/WoodpeckerCI)`

Add gitpod setup (#1020) Adding [Gitpod](https://github.com/gitpod-io/gitpod) allows us and others to easily start a complete Woodpecker setup and development cloud IDE. It starts a Woodpecker server, agent and a preconfigured Gitea instance. You can login at Gitea with `woodpecker` and `password`. 2022-07-31 15:07:18 +00:00			`## ✨ Stars over time`

Update README (#560) * Add "Stars over time to README * Move info from README into docs & link to it * New CI location * New screenshot Co-authored-by: John Olheiser <john.olheiser@gmail.com> 2021-12-03 14:36:22 +00:00			`[![Stargazers over time](https://starchart.cc/woodpecker-ci/woodpecker.svg)](https://starchart.cc/woodpecker-ci/woodpecker)`
Community Guide (#296) Add a Community-Guide template was taken from [gitea](https://github.com/go-gitea/gitea/blob/main/CONTRIBUTING.md) Signed-off-by: 6543 <6543@obermui.de> Co-authored-by: Anbraten <anton@ju60.de> Co-authored-by: Malachi Soord <inverse.chi@gmail.com> 2021-09-11 21:45:18 +00:00
Readme 2019-07-05 13:30:25 +00:00			`## License`

Tidy up readme (#253) 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.`
Readme 2019-07-05 13:30:25 +00:00
Community Guide (#296) Add a Community-Guide template was taken from [gitea](https://github.com/go-gitea/gitea/blob/main/CONTRIBUTING.md) Signed-off-by: 6543 <6543@obermui.de> Co-authored-by: Anbraten <anton@ju60.de> Co-authored-by: Malachi Soord <inverse.chi@gmail.com> 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.