woodpecker/README.md

<p align="center">
  <a href="https://github.com/woodpecker-ci/woodpecker/">
    <img alt="Woodpecker" src="docs/static/img/logo-auto-darkmode.svg" width="220"/>
  </a>
</p>
<br/>
<p align="center">
  <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">
  </a>
  <a href="https://codecov.io/gh/woodpecker-ci/woodpecker">
    <img src="https://codecov.io/gh/woodpecker-ci/woodpecker/branch/master/graph/badge.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?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/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>
  <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>
</p>
<br/>

# Woodpecker

> Woodpecker is a community fork of the Drone CI system.

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

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

### .woodpecker.yml

- Place your pipeline in a file named `.woodpecker.yml` in your repository
- Pipeline steps can be named as you like
- Run any command in the commands section

[Read More](https://woodpecker-ci.org/docs/usage/intro)

### Build steps are containers

- Define any Docker image as context
- Install the needed tools in custom Docker images, use them as context

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

## 📖 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/development/getting-started#gitpod)

## 👋 Who uses Woodpecker?

[Codeberg](https://codeberg.org), the Woodpecker project itself, and many others.

Leave a [comment](https://github.com/woodpecker-ci/woodpecker/issues/122) 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/hashtag/WoodpeckerCI?f=live)
- [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.
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/">`
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			`<img alt="Woodpecker" src="docs/static/img/logo-auto-darkmode.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 (#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			`<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">`
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">`
			`<img src="https://codecov.io/gh/woodpecker-ci/woodpecker/branch/master/graph/badge.svg"/>`
			`</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>`
			`<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>`
Add TODOs badge to README (#731) <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> 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>`
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
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			`# Woodpecker`
Some info on the project 2019-06-04 07:37:15 +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			`> Woodpecker is a community fork of the Drone CI system.`
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
			`Please consider to donate 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			`## 🚀 Usage`
Some info on the project 2019-06-04 07:37:15 +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			`### .woodpecker.yml`

			- Place your pipeline in a file named `.woodpecker.yml` in your repository
Simplified Github README 2019-11-15 10:13:16 +00:00			`- Pipeline steps can be named as you like`
			`- Run any command in the commands section`
Readme 2019-07-05 13:30:25 +00:00
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			`[Read More](https://woodpecker-ci.org/docs/usage/intro)`
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			`### Build steps are containers`
Readme 2019-07-05 13:30:25 +00:00
Simplified Github README 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`
Readme 2019-07-05 13:30:25 +00:00
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			`[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)`
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			`## 📖 Documentation`
Readme 2019-07-05 13:30:25 +00:00
Update links to woodpecker-ci.org (#445) 2021-10-14 16:13:57 +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 docs link (#1076) 2022-08-04 10:56:31 +00:00			`[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://woodpecker-ci.org/docs/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
			`## 👋 Who uses Woodpecker?`
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			`[Codeberg](https://codeberg.org), the Woodpecker project itself, and many others.`
Fixing tests 2021-02-19 08:57:34 +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			`Leave a [comment](https://github.com/woodpecker-ci/woodpecker/issues/122) 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] show twitter link with content 2022-03-14 14:09:00 +00:00			`- [Twitter](https://twitter.com/hashtag/WoodpeckerCI?f=live)`
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.