diff --git a/README.md b/README.md index dec15836095..7cd7de1d5c8 100644 --- a/README.md +++ b/README.md @@ -43,55 +43,50 @@


-Woodpecker is a simple yet powerful CI/CD engine with great extensibility. +Woodpecker is a simple, yet powerful CI/CD engine with great extensibility. ![woodpecker](docs/docs/woodpecker.png) -## 🫶 Support +## Installation & Resources -Please consider donating and become a backer. 🙏 [[Become a backer](https://opencollective.com/woodpecker-ci#category-CONTRIBUTE)] +Woodpecker can be installed in various ways (see the [Installation Instructions](https://woodpecker-ci.org/docs/administration/getting-started)) and by, default, runs with a SQLite DB. +It requires around 100 MB of RAM (Server) and 30 MB (Agent) at runtime in idle mode. -Open Collective backers - -## 📖 Documentation +## Support - +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). -## ✨ Contribute - -See [Contributing Guide](https://github.com/woodpecker-ci/.github/blob/main/CONTRIBUTING.md) +Open Collective backers -[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://woodpecker-ci.org/docs/next/development/getting-started#gitpod) +## Documentation -## 📣 Translate + -We use an own [Weblate](https://weblate.org/en/) instance at [translate.woodpecker-ci.org](https://translate.woodpecker-ci.org). +## Translation - - Translation status - +We have a self-hosted [Weblate](https://weblate.org/en/) instance at [translate.woodpecker-ci.org](https://translate.woodpecker-ci.org). -## 👋 Who uses Woodpecker? +An overview of the current translation state is available at . -Woodpecker is used by [itself](https://ci.woodpecker-ci.org/woodpecker/woodpecker-ci/), multiple well-known companies, organizations like [Codeberg](https://codeberg.org), hobbyists and many others. +To help with translation, the language-specific files in can be edited. -Leave a [comment](https://github.com/woodpecker-ci/woodpecker/discussions/2149) if you're using it as well. +## Public Woodpecker Instances -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! +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. -Here are some places where people mention Woodpecker: +## Plugins -- [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) +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. -## ✨ Stars over time +## Star History -[![Stargazers over time](https://starchart.cc/woodpecker-ci/woodpecker.svg)](https://starchart.cc/woodpecker-ci/woodpecker) +[![Star History Chart](https://api.star-history.com/svg?repos=woodpecker-ci/woodpecker&type=Date)](https://star-history.com/#woodpecker-ci/woodpecker&Date) ## 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. +Woodpecker is Apache 2.0 licensed. +The source files have 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. +Everything in `docs/` is licensed under the Creative Commons Attribution-ShareAlike 4.0 International Public License. diff --git a/cmd/server/swagger.go b/cmd/server/swagger.go index a38ec599edd..2acb8be7638 100644 --- a/cmd/server/swagger.go +++ b/cmd/server/swagger.go @@ -33,7 +33,7 @@ func setupSwaggerStaticConfig() { docs.SwaggerInfo.InfoInstanceName = "api" docs.SwaggerInfo.Title = "Woodpecker CI API" docs.SwaggerInfo.Version = version.String() - docs.SwaggerInfo.Description = "Woodpecker is a simple yet powerful CI/CD engine with great extensibility.\n" + + docs.SwaggerInfo.Description = "Woodpecker is a simple, yet powerful CI/CD engine with great extensibility.\n" + "To get a personal access token (PAT) for authentication, please log in your Woodpecker server,\n" + "and go to you personal profile page, by clicking the user icon at the top right." } diff --git a/docs/docs/30-administration/05-deployment-methods/30-third-party.md b/docs/docs/30-administration/05-deployment-methods/30-third-party.md index acad9c0fd84..8eabded39a8 100644 --- a/docs/docs/30-administration/05-deployment-methods/30-third-party.md +++ b/docs/docs/30-administration/05-deployment-methods/30-third-party.md @@ -1,12 +1,12 @@ -# Third-party installation methods +# Distribution packages :::info -These installation methods are not officially supported. If you experience issues with them, please open issues in the specific repositories. +Woodpecker itself is not responsible for creating these packages. Please reach out to the people responsible for packaging Woodpecker for the individual distributions. ::: -- [Using NixOS](./40-nixos.md) via the [NixOS module](https://search.nixos.org/options?channel=unstable&size=200&sort=relevance&query=woodpecker) -- [On Alpine Edge](https://pkgs.alpinelinux.org/packages?name=woodpecker&branch=edge&repo=&arch=&maintainer=) -- [On Arch Linux](https://archlinux.org/packages/?q=woodpecker) -- [On openSUSE](https://software.opensuse.org/package/woodpecker) -- [Using YunoHost](https://apps.yunohost.org/app/woodpecker) -- [On Cloudron](https://www.cloudron.io/store/org.woodpecker_ci.cloudronapp.html) +- [NixOS](./40-nixos.md) via the [NixOS module](https://search.nixos.org/options?channel=unstable&size=200&sort=relevance&query=woodpecker) +- [Alpine (Edge)](https://pkgs.alpinelinux.org/packages?name=woodpecker&branch=edge&repo=&arch=&maintainer=) +- [Arch Linux](https://archlinux.org/packages/?q=woodpecker) +- [openSUSE](https://software.opensuse.org/package/woodpecker) +- [YunoHost](https://apps.yunohost.org/app/woodpecker) +- [Cloudron](https://www.cloudron.io/store/org.woodpecker_ci.cloudronapp.html) diff --git a/docs/docs/woodpecker.png b/docs/docs/woodpecker.png index b92f3589f55..93b4d47af08 100644 Binary files a/docs/docs/woodpecker.png and b/docs/docs/woodpecker.png differ diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index c1b1e0a8fb2..a3f010d31ff 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -5,7 +5,7 @@ import * as path from 'path'; const config: Config = { title: 'Woodpecker CI', - tagline: 'Woodpecker is a simple yet powerful CI/CD engine with great extensibility.', + tagline: 'Woodpecker is a simple, yet powerful CI/CD engine with great extensibility.', url: 'https://woodpecker-ci.org', baseUrl: '/', onBrokenLinks: 'throw', diff --git a/docs/src/pages/index.tsx b/docs/src/pages/index.tsx index 9fc47c2e5e4..0bddd28dbc5 100644 --- a/docs/src/pages/index.tsx +++ b/docs/src/pages/index.tsx @@ -14,7 +14,7 @@ function HomepageHeader() {

{siteConfig.title}

{siteConfig.tagline}

- + Woodpecker Tutorial - 5min ⏱️
@@ -28,7 +28,7 @@ export default function Home() { return (
diff --git a/docs/versioned_docs/version-2.5/10-intro.md b/docs/versioned_docs/version-2.5/10-intro.md index 309c6f1af42..e4624e6236f 100644 --- a/docs/versioned_docs/version-2.5/10-intro.md +++ b/docs/versioned_docs/version-2.5/10-intro.md @@ -1,6 +1,6 @@ # Welcome to Woodpecker -Woodpecker is a simple yet powerful CI/CD engine with great extensibility. It focuses on executing pipelines inside [containers](https://opencontainers.org/). +Woodpecker is a simple, yet powerful CI/CD engine with great extensibility. It focuses on executing pipelines inside [containers](https://opencontainers.org/). If you are already using containers in your daily workflow, you'll for sure love Woodpecker. ![woodpecker](woodpecker.png) diff --git a/docs/versioned_docs/version-2.6/10-intro.md b/docs/versioned_docs/version-2.6/10-intro.md index 309c6f1af42..e4624e6236f 100644 --- a/docs/versioned_docs/version-2.6/10-intro.md +++ b/docs/versioned_docs/version-2.6/10-intro.md @@ -1,6 +1,6 @@ # Welcome to Woodpecker -Woodpecker is a simple yet powerful CI/CD engine with great extensibility. It focuses on executing pipelines inside [containers](https://opencontainers.org/). +Woodpecker is a simple, yet powerful CI/CD engine with great extensibility. It focuses on executing pipelines inside [containers](https://opencontainers.org/). If you are already using containers in your daily workflow, you'll for sure love Woodpecker. ![woodpecker](woodpecker.png) diff --git a/server/forge/github/fixtures/hooks.go b/server/forge/github/fixtures/hooks.go index bae47d9e10e..895c537ba9c 100644 --- a/server/forge/github/fixtures/hooks.go +++ b/server/forge/github/fixtures/hooks.go @@ -49,7 +49,7 @@ const HookPush = `{ "site_admin": false }, "html_url": "https://github.com/woodpecker-ci/woodpecker", - "description": "Woodpecker is a simple yet powerful CI/CD engine with great extensibility.", + "description": "Woodpecker is a simple, yet powerful CI/CD engine with great extensibility.", "fork": false, "url": "https://github.com/woodpecker-ci/woodpecker", "forks_url": "https://api.github.com/repos/woodpecker-ci/woodpecker/forks", @@ -152,7 +152,7 @@ const HookPush = `{ "members_url": "https://api.github.com/orgs/woodpecker-ci/members{/member}", "public_members_url": "https://api.github.com/orgs/woodpecker-ci/public_members{/member}", "avatar_url": "https://avatars.githubusercontent.com/u/84780935?v=4", - "description": "Woodpecker is a simple yet powerful CI/CD engine with great extensibility." + "description": "Woodpecker is a simple, yet powerful CI/CD engine with great extensibility." }, "sender": { "login": "6543",