Co-authored-by: Anbraten <6918444+anbraten@users.noreply.github.com>
This commit is contained in:
qwerty287 2024-06-03 09:12:42 +02:00 committed by GitHub
parent bbe3f4e393
commit f02902d099
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
13 changed files with 63 additions and 85 deletions

View file

@ -0,0 +1,37 @@
# Troubleshooting
## How to debug clone issues
(And what to do with an error message like `fatal: could not read Username for 'https://<url>': No such device or address`)
This error can have multiple causes. If you use internal repositories you might have to enable `WOODPECKER_AUTHENTICATE_PUBLIC_REPOS`:
```ini
WOODPECKER_AUTHENTICATE_PUBLIC_REPOS=true
```
If that does not work, try to make sure the container can reach your git server. In order to do that disable git checkout and make the container "hang":
```yaml
skip_clone: true
steps:
build:
image: debian:stable-backports
commands:
- apt update
- apt install -y inetutils-ping wget
- ping -c 4 git.example.com
- wget git.example.com
- sleep 9999999
```
Get the container id using `docker ps` and copy the id from the first column. Enter the container with: `docker exec -it 1234asdf bash` (replace `1234asdf` with the docker id). Then try to clone the git repository with the commands from the failing pipeline:
```bash
git init
git remote add origin https://git.example.com/username/repo.git
git fetch --no-tags origin +refs/heads/branch:
```
(replace the url AND the branch with the correct values, use your username and password as log in values)

View file

@ -16,7 +16,11 @@ You can add more agents to increase the number of parallel workflows or set the
Woodpecker is having two different kinds of releases: **stable** and **next**. Woodpecker is having two different kinds of releases: **stable** and **next**.
To find out more about the differences between the two releases, please read the [FAQ](/faq#which-version-of-woodpecker-should-i-use). The **stable** releases are official versions following [semver](https://semver.org/). By default, only the latest stable release will receive bug fixes. Once a new major or minor release is available, previous minor versions might only receive security patches, but wont be updated with bug fixes anymore (so called backporting) by default.
The **next** release contains all bugfixes and features from `main` branch. Normally it should be pretty stable, but as its frequently updated, it might contain some bugs from time to time. There are no binaries for this version.
If you want all (new) features of Woodpecker and are willing to accept some possible bugs from time to time, you should use the next release, otherwise use the stable release.
### Stable releases ### Stable releases
@ -87,6 +91,8 @@ In the case you need to use Woodpecker with a URL path prefix (like: <https://ex
These installation methods are not officially supported. If you experience issues with them, please open issues in the specific repositories. These installation methods are not officially supported. If you experience issues with them, please open issues in the specific repositories.
::: :::
- Using [NixOS](./30-nixos.md) via the [NixOS module](https://search.nixos.org/options?channel=unstable&size=200&sort=relevance&query=woodpecker) - [Using NixOS](./30-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)
- [Using YunoHost](https://apps.yunohost.org/app/woodpecker) - [Using YunoHost](https://apps.yunohost.org/app/woodpecker)
- [On Cloudron](https://www.cloudron.io/store/org.woodpecker_ci.cloudronapp.html) - [On Cloudron](https://www.cloudron.io/store/org.woodpecker_ci.cloudronapp.html)

18
docs/docs/50-about.md Normal file
View file

@ -0,0 +1,18 @@
# About
Woodpecker has been originally forked from Drone 0.8 as the Drone CI license was changed after the 0.8 release from Apache 2.0 to a proprietary license. Woodpecker is based on this latest freely available version.
## History
Woodpecker was originally forked by [@laszlocph](https://github.com/laszlocph) in 2019.
A few important time points:
- [`2fbaa56`](https://github.com/woodpecker-ci/woodpecker/commit/2fbaa56eee0f4be7a3ca4be03dbd00c1bf5d1274) is the first commit of the fork, made on Apr 3, 2019.
- The first release [v0.8.91](https://github.com/woodpecker-ci/woodpecker/releases/tag/v0.8.91) was published on Apr 6, 2019.
- On Aug 27, 2019, the project was renamed to "Woodpecker" ([`630c383`](https://github.com/woodpecker-ci/woodpecker/commit/630c383181b10c4ec375e500c812c4b76b3c52b8)).
- The first release under the name "Woodpecker" was published on Sep 9, 2019 ([v0.8.104](https://github.com/woodpecker-ci/woodpecker/releases/tag/v0.8.104)).
## Differences to Drone
Woodpecker is a community-focused software that still stay free and open source forever, while Drone is managed by [Harness](https://harness.io/) and published under [Polyform Small Business](https://polyformproject.org/licenses/small-business/1.0.0/) license.

View file

@ -50,10 +50,6 @@ const config: Config = {
activeBaseRegex: 'docs/(next/)?awesome', activeBaseRegex: 'docs/(next/)?awesome',
label: 'Awesome', label: 'Awesome',
}, },
{
to: '/faq',
label: 'FAQ',
},
{ {
to: '/api', to: '/api',
label: 'API', label: 'API',
@ -96,10 +92,6 @@ const config: Config = {
label: 'Server setup', label: 'Server setup',
to: '/docs/administration/deployment/overview', to: '/docs/administration/deployment/overview',
}, },
{
label: 'FAQ',
to: '/faq',
},
], ],
}, },
{ {

View file

@ -1,59 +0,0 @@
# FAQ
## What are the differences to Drone?
Apart from Woodpecker staying free and OpenSource forever, the growing community already introduced some nifty features like:
- [Multiple workflows](/docs/next/usage/workflows)
- [Conditional step execution on file changes](/docs/next/usage/workflow-syntax#path)
- [More features are already in the pipeline :wink:](https://github.com/woodpecker-ci/woodpecker/pulls) ...
## Why is Woodpecker a fork of Drone version 0.8?
The Drone CI license was changed after the 0.8 release from Apache 2 to a proprietary license. Woodpecker is based on this latest freely available version.
## Which version of Woodpecker should I use?
Woodpecker is having two different kinds of releases: **stable** and **next**.
The **stable** releases (currently version 2.3) are long-term supported (LTS) stable versions. The stable releases are only getting bugfixes.
The **next** release contains all bugfixes and features from `main` branch. Normally it should be pretty stable, but as its frequently updated, it might contain some bugs from time to time. There are no binaries for this version.
If you want all (new) features of Woodpecker and are willing to accept some possible bugs from time to time, you should use the next release otherwise use the stable release.
## How to debug clone issues
(And what to do with an error message like `fatal: could not read Username for 'https://<url>': No such device or address`)
This error can have multiple causes. If you use internal repositories you might have to enable `WOODPECKER_AUTHENTICATE_PUBLIC_REPOS`:
```ini
WOODPECKER_AUTHENTICATE_PUBLIC_REPOS=true
```
If that does not work, try to make sure the container can reach your git server. In order to do that disable git checkout and make the container "hang":
```yaml
skip_clone: true
steps:
build:
image: debian:stable-backports
commands:
- apt update
- apt install -y inetutils-ping wget
- ping -c 4 git.example.com
- wget git.example.com
- sleep 9999999
```
Get the container id using `docker ps` and copy the id from the first column. Enter the container with: `docker exec -it 1234asdf bash` (replace `1234asdf` with the docker id). Then try to clone the git repository with the commands from the failing pipeline:
```bash
git init
git remote add origin https://git.example.com/username/repo.git
git fetch --no-tags origin +refs/heads/branch:
```
(replace the url AND the branch with the correct values, use your username and password as log in values)

View file

@ -15,8 +15,6 @@ A Woodpecker deployment consists of two parts:
Woodpecker is having two different kinds of releases: **stable** and **next**. Woodpecker is having two different kinds of releases: **stable** and **next**.
To find out more about the differences between the two releases, please read the [FAQ](/faq).
## Hardware Requirements ## Hardware Requirements
Below are resources requirements for Woodpecker components itself: Below are resources requirements for Woodpecker components itself:

View file

@ -4,8 +4,6 @@
Woodpecker is having two different kinds of releases: **stable** and **next**. Woodpecker is having two different kinds of releases: **stable** and **next**.
To find out more about the differences between the two releases, please read the [FAQ](/faq).
## Binaries & DEB, RPM ## Binaries & DEB, RPM
[Latest release](https://github.com/woodpecker-ci/woodpecker/releases/latest) [Latest release](https://github.com/woodpecker-ci/woodpecker/releases/latest)

View file

@ -16,8 +16,6 @@ You can add more agents to increase the number of parallel workflows or set the
Woodpecker is having two different kinds of releases: **stable** and **next**. Woodpecker is having two different kinds of releases: **stable** and **next**.
To find out more about the differences between the two releases, please read the [FAQ](/faq#which-version-of-woodpecker-should-i-use).
## Hardware Requirements ## Hardware Requirements
Below are minimal resources requirements for Woodpecker components itself: Below are minimal resources requirements for Woodpecker components itself:

View file

@ -16,8 +16,6 @@ You can add more agents to increase the number of parallel workflows or set the
Woodpecker is having two different kinds of releases: **stable** and **next**. Woodpecker is having two different kinds of releases: **stable** and **next**.
To find out more about the differences between the two releases, please read the [FAQ](/faq#which-version-of-woodpecker-should-i-use).
## Hardware Requirements ## Hardware Requirements
Below are minimal resources requirements for Woodpecker components itself: Below are minimal resources requirements for Woodpecker components itself:

View file

@ -16,8 +16,6 @@ You can add more agents to increase the number of parallel workflows or set the
Woodpecker is having two different kinds of releases: **stable** and **next**. Woodpecker is having two different kinds of releases: **stable** and **next**.
To find out more about the differences between the two releases, please read the [FAQ](/faq#which-version-of-woodpecker-should-i-use).
## Hardware Requirements ## Hardware Requirements
Below are minimal resources requirements for Woodpecker components itself: Below are minimal resources requirements for Woodpecker components itself:

View file

@ -16,8 +16,6 @@ You can add more agents to increase the number of parallel workflows or set the
Woodpecker is having two different kinds of releases: **stable** and **next**. Woodpecker is having two different kinds of releases: **stable** and **next**.
To find out more about the differences between the two releases, please read the [FAQ](/faq#which-version-of-woodpecker-should-i-use).
### Stable releases ### Stable releases
We release a new version every four weeks and will release the current state of the `main` branch. We release a new version every four weeks and will release the current state of the `main` branch.

View file

@ -16,8 +16,6 @@ You can add more agents to increase the number of parallel workflows or set the
Woodpecker is having two different kinds of releases: **stable** and **next**. Woodpecker is having two different kinds of releases: **stable** and **next**.
To find out more about the differences between the two releases, please read the [FAQ](/faq#which-version-of-woodpecker-should-i-use).
### Stable releases ### Stable releases
We release a new version every four weeks and will release the current state of the `main` branch. We release a new version every four weeks and will release the current state of the `main` branch.

View file

@ -16,8 +16,6 @@ You can add more agents to increase the number of parallel workflows or set the
Woodpecker is having two different kinds of releases: **stable** and **next**. Woodpecker is having two different kinds of releases: **stable** and **next**.
To find out more about the differences between the two releases, please read the [FAQ](/faq#which-version-of-woodpecker-should-i-use).
### Stable releases ### Stable releases
We release a new version every four weeks and will release the current state of the `main` branch. We release a new version every four weeks and will release the current state of the `main` branch.