From a1e12f9ce67cfbf41f68c028f87bfc8981c58147 Mon Sep 17 00:00:00 2001 From: qwerty287 <80460567+qwerty287@users.noreply.github.com> Date: Mon, 25 Aug 2025 09:37:29 +0200 Subject: [PATCH 1/4] Add ui proxy docs --- docs/versioned_docs/version-3.9/92-development/03-ui.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/versioned_docs/version-3.9/92-development/03-ui.md b/docs/versioned_docs/version-3.9/92-development/03-ui.md index 1931ba99a65..8186b63f321 100644 --- a/docs/versioned_docs/version-3.9/92-development/03-ui.md +++ b/docs/versioned_docs/version-3.9/92-development/03-ui.md @@ -13,6 +13,15 @@ Testing UI changes would require us to rebuild the UI after each adjustment to t Start the UI server locally with [hot-reloading](https://stackoverflow.com/a/41429055/8461267) by running: `pnpm start`. To enable the forwarding of requests to the UI server you have to enable the dev-proxy inside the Woodpecker server by adding `WOODPECKER_DEV_WWW_PROXY=http://localhost:8010` to your `.env` file. After starting the Woodpecker server as explained in the [debugging](./01-getting-started.md#debugging-woodpecker) section, you should now be able to access the UI under [http://localhost:8000](http://localhost:8000). +### Usage with remote server + +If you would like to test your UI changes on a "real-world" Woodpecker server which probably has more complex data than local test instances, you can run `pnpm start` with these environment variables: + +- `VITE_DEV_PROXY`: your server URL, for example `https://ci.woodpecker-ci.org` +- `VITE_DEV_USER_SESS_COOKIE`: the value `user_sess` cookie in your browser + +Then, open the UI at `http://localhost:8010`. + ## Tools and frameworks The following list contains some tools and frameworks used by the Woodpecker UI. For some points we added some guidelines / hints to help you developing. From 604937f61bbda66c909749823d40f7f119164eae Mon Sep 17 00:00:00 2001 From: qwerty287 <80460567+qwerty287@users.noreply.github.com> Date: Mon, 25 Aug 2025 12:47:06 +0200 Subject: [PATCH 2/4] Update 03-ui.md --- docs/docs/92-development/03-ui.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/docs/92-development/03-ui.md b/docs/docs/92-development/03-ui.md index 1931ba99a65..25990f80f0b 100644 --- a/docs/docs/92-development/03-ui.md +++ b/docs/docs/92-development/03-ui.md @@ -13,6 +13,15 @@ Testing UI changes would require us to rebuild the UI after each adjustment to t Start the UI server locally with [hot-reloading](https://stackoverflow.com/a/41429055/8461267) by running: `pnpm start`. To enable the forwarding of requests to the UI server you have to enable the dev-proxy inside the Woodpecker server by adding `WOODPECKER_DEV_WWW_PROXY=http://localhost:8010` to your `.env` file. After starting the Woodpecker server as explained in the [debugging](./01-getting-started.md#debugging-woodpecker) section, you should now be able to access the UI under [http://localhost:8000](http://localhost:8000). +### Usage with remote server + + If you would like to test your UI changes on a "real-world" Woodpecker server which probably has more complex data than local test instances, you can run `pnpm start` with these environment variables: + + - `VITE_DEV_PROXY`: your server URL, for example `https://ci.woodpecker-ci.org` + - `VITE_DEV_USER_SESS_COOKIE`: the value `user_sess` cookie in your browser + + Then, open the UI at `http://localhost:8010`. + ## Tools and frameworks The following list contains some tools and frameworks used by the Woodpecker UI. For some points we added some guidelines / hints to help you developing. From 8d15e0df7b60193a72737268960386c307d6c1ed Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 10:47:34 +0000 Subject: [PATCH 3/4] [pre-commit.ci] auto fixes from pre-commit.com hooks [CI SKIP] for more information, see https://pre-commit.ci --- docs/docs/92-development/03-ui.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/docs/92-development/03-ui.md b/docs/docs/92-development/03-ui.md index 25990f80f0b..0e04ce1aa6f 100644 --- a/docs/docs/92-development/03-ui.md +++ b/docs/docs/92-development/03-ui.md @@ -13,14 +13,14 @@ Testing UI changes would require us to rebuild the UI after each adjustment to t Start the UI server locally with [hot-reloading](https://stackoverflow.com/a/41429055/8461267) by running: `pnpm start`. To enable the forwarding of requests to the UI server you have to enable the dev-proxy inside the Woodpecker server by adding `WOODPECKER_DEV_WWW_PROXY=http://localhost:8010` to your `.env` file. After starting the Woodpecker server as explained in the [debugging](./01-getting-started.md#debugging-woodpecker) section, you should now be able to access the UI under [http://localhost:8000](http://localhost:8000). -### Usage with remote server - - If you would like to test your UI changes on a "real-world" Woodpecker server which probably has more complex data than local test instances, you can run `pnpm start` with these environment variables: - - - `VITE_DEV_PROXY`: your server URL, for example `https://ci.woodpecker-ci.org` - - `VITE_DEV_USER_SESS_COOKIE`: the value `user_sess` cookie in your browser - - Then, open the UI at `http://localhost:8010`. +### Usage with remote server + + If you would like to test your UI changes on a "real-world" Woodpecker server which probably has more complex data than local test instances, you can run `pnpm start` with these environment variables: + + - `VITE_DEV_PROXY`: your server URL, for example `https://ci.woodpecker-ci.org` + - `VITE_DEV_USER_SESS_COOKIE`: the value `user_sess` cookie in your browser + + Then, open the UI at `http://localhost:8010`. ## Tools and frameworks From 49e503ef3c8c2c7193db625ece4ccb340b9da19c Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Mon, 25 Aug 2025 13:59:07 +0200 Subject: [PATCH 4/4] Update docs/docs/92-development/03-ui.md --- docs/docs/92-development/03-ui.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/92-development/03-ui.md b/docs/docs/92-development/03-ui.md index 0e04ce1aa6f..0c1ac3bc6b3 100644 --- a/docs/docs/92-development/03-ui.md +++ b/docs/docs/92-development/03-ui.md @@ -17,8 +17,8 @@ After starting the Woodpecker server as explained in the [debugging](./01-gettin If you would like to test your UI changes on a "real-world" Woodpecker server which probably has more complex data than local test instances, you can run `pnpm start` with these environment variables: - - `VITE_DEV_PROXY`: your server URL, for example `https://ci.woodpecker-ci.org` - - `VITE_DEV_USER_SESS_COOKIE`: the value `user_sess` cookie in your browser +- `VITE_DEV_PROXY`: your server URL, for example `https://ci.woodpecker-ci.org` +- `VITE_DEV_USER_SESS_COOKIE`: the value `user_sess` cookie in your browser Then, open the UI at `http://localhost:8010`.