mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-11-23 10:21:00 +00:00
646f2c5c7a
to finally release 2.2 --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
160 lines
6.7 KiB
Markdown
160 lines
6.7 KiB
Markdown
# Getting started
|
|
|
|
## Core ideas
|
|
|
|
- A (e.g. pipeline) configuration should never be [turing complete](https://en.wikipedia.org/wiki/Turing_completeness) (We have agents to exec things 🙂).
|
|
- If possible follow the [KISS principle](https://en.wikipedia.org/wiki/KISS_principle).
|
|
- What is used most should be default.
|
|
- Keep different topics separated, so you can write plugins, port new ideas ... more easily, see [Architecture](./05-architecture.md).
|
|
|
|
You can develop on your local computer by following the [steps below](#preparation-for-local-development) or you can start with a fully prepared online setup using [Gitpod](https://github.com/gitpod-io/gitpod) and [Gitea](https://github.com/go-gitea/gitea).
|
|
|
|
## Gitpod
|
|
|
|
If you want to start development or updating docs as easy as possible, you can use our preconfigured setup for Woodpecker using [Gitpod](https://github.com/gitpod-io/gitpod). Gitpod starts a complete development setup in the cloud containing:
|
|
|
|
- An IDE in the browser or bridged to your local VS-Code or Jetbrains
|
|
- A preconfigured [Gitea](https://github.com/go-gitea/gitea) instance as forge
|
|
- A preconfigured Woodpecker server
|
|
- A single preconfigured Woodpecker agent node
|
|
- Our docs preview server
|
|
|
|
Start Woodpecker in Gitpod by clicking on the following badge. You can log in with `woodpecker` and `password`.
|
|
|
|
[](https://gitpod.io/#https://github.com/woodpecker-ci/woodpecker)
|
|
|
|
## Preparation for local development
|
|
|
|
### Install Go
|
|
|
|
Install Golang (>=1.20) as described by [this guide](https://go.dev/doc/install).
|
|
|
|
### Install make
|
|
|
|
> GNU Make is a tool which controls the generation of executables and other non-source files of a program from the program's source files (<https://www.gnu.org/software/make/>).
|
|
|
|
Install make on:
|
|
|
|
- Ubuntu: `apt install make` - [Docs](https://wiki.ubuntuusers.de/Makefile/)
|
|
- [Windows](https://stackoverflow.com/a/32127632/8461267)
|
|
- Mac OS: `brew install make`
|
|
|
|
### Install Node.js & `pnpm`
|
|
|
|
Install [Node.js (>=14)](https://nodejs.org/en/download/) if you want to build Woodpecker's UI or documentation.
|
|
|
|
For dependency installation (`node_modules`) of UI and documentation of Woodpecker the package manager pnpm is used.
|
|
[This guide](https://pnpm.io/installation) describes the installation of `pnpm`.
|
|
|
|
### Install `pre-commit` (optional)
|
|
|
|
Woodpecker uses [`pre-commit`](https://pre-commit.com/) to allow you to easily autofix your code.
|
|
To apply it during local development, take a look at [`pre-commit`s documentation](https://pre-commit.com/#usage).
|
|
|
|
### Create a `.env` file with your development configuration
|
|
|
|
Similar to the environment variables you can set for your production setup of Woodpecker, you can create a `.env` in the root of the Woodpecker project and add any need config to it.
|
|
|
|
A common config for debugging would look like this:
|
|
|
|
```ini
|
|
WOODPECKER_OPEN=true
|
|
WOODPECKER_ADMIN=your-username
|
|
|
|
# if you want to test webhooks with an online forge like GitHub this address needs to be accessible from public server
|
|
WOODPECKER_HOST=http://your-dev-address.com
|
|
|
|
# github (sample for a forge config - see /docs/administration/forge/overview for other forges)
|
|
WOODPECKER_GITHUB=true
|
|
WOODPECKER_GITHUB_CLIENT=<redacted>
|
|
WOODPECKER_GITHUB_SECRET=<redacted>
|
|
|
|
# agent
|
|
WOODPECKER_SERVER=localhost:9000
|
|
WOODPECKER_AGENT_SECRET=a-long-and-secure-password-used-for-the-local-development-system
|
|
WOODPECKER_MAX_WORKFLOWS=1
|
|
|
|
# enable if you want to develop the UI
|
|
# WOODPECKER_DEV_WWW_PROXY=http://localhost:8010
|
|
|
|
# used so you can login without using a public address
|
|
WOODPECKER_DEV_OAUTH_HOST=http://localhost:8000
|
|
|
|
# disable health-checks while debugging (normally not needed while developing)
|
|
WOODPECKER_HEALTHCHECK=false
|
|
|
|
# WOODPECKER_LOG_LEVEL=debug
|
|
# WOODPECKER_LOG_LEVEL=trace
|
|
```
|
|
|
|
### Setup OAuth
|
|
|
|
Create an OAuth app for your forge as described in the [forges documentation](../30-administration/11-forges/10-overview.md). If you set `WOODPECKER_DEV_OAUTH_HOST=http://localhost:8000` you can use that address with the path as explained for the specific forge to login without the need for a public address. For example for GitHub you would use `http://localhost:8000/authorize` as authorization callback URL.
|
|
|
|
## Developing with VS Code
|
|
|
|
You can use different methods for debugging the Woodpecker applications. One of the currently recommended ways to debug and test the Woodpecker application is using [VS-Code](https://code.visualstudio.com/) or [VS-Codium](https://vscodium.com/) (Open-Source binaries of VS-Code) as most maintainers are using it and Woodpecker already includes the needed debug configurations for it.
|
|
|
|
To launch all needed services for local development, you can use "Woodpecker CI" debugging configuration that will launch UI, server and agent in debugging mode. Then open `http://localhost:8000` to access it.
|
|
|
|
As a starting guide for programming Go with VS Code, you can use this video guide:
|
|
[](https://www.youtube.com/watch?v=1MXIGYrMk80)
|
|
|
|
### Debugging Woodpecker
|
|
|
|
The Woodpecker source code already includes launch configurations for the Woodpecker server and agent. To start debugging you can click on the debug icon in the navigation bar of VS-Code (ctrl-shift-d). On that page you will see the existing launch jobs at the top. Simply select the agent or server and click on the play button. You can set breakpoints in the source files to stop at specific points.
|
|
|
|
|
|
|
|
## Testing & linting code
|
|
|
|
To test or lint parts of Woodpecker, you can run one of the following commands:
|
|
|
|
```bash
|
|
# test server code
|
|
make test-server
|
|
|
|
# test agent code
|
|
make test-agent
|
|
|
|
# test cli code
|
|
make test-cli
|
|
|
|
# test datastore / database related code like migrations of the server
|
|
make test-server-datastore
|
|
|
|
# lint go code
|
|
make lint
|
|
|
|
# lint UI code
|
|
make lint-frontend
|
|
|
|
# test UI code
|
|
make test-frontend
|
|
```
|
|
|
|
If you want to test a specific Go file, you can also use:
|
|
|
|
```bash
|
|
go test -race -timeout 30s go.woodpecker-ci.org/woodpecker/v2/<path-to-the-package-or-file-to-test>
|
|
```
|
|
|
|
Or you can open the test-file inside [VS-Code](#developing-with-vs-code) and run or debug the test by clicking on the inline commands:
|
|
|
|
|
|
|
|
## Run applications from terminal
|
|
|
|
If you want to run a Woodpecker applications from your terminal, you can use one of the following commands from the base of the Woodpecker project. They will execute Woodpecker in a similar way as described in [debugging Woodpecker](#debugging-woodpecker) without the ability to really debug it in your editor.
|
|
|
|
```bash title="start server"
|
|
go run ./cmd/server
|
|
```
|
|
|
|
```bash title="start agent"
|
|
go run ./cmd/agent
|
|
```
|
|
|
|
```bash title="execute cli command"
|
|
go run ./cmd/cli [command]
|
|
```
|