diff --git a/docs/docs/20-usage/30-matrix-workflows.md b/docs/docs/20-usage/30-matrix-workflows.md index a5ba107c9e..9548205239 100644 --- a/docs/docs/20-usage/30-matrix-workflows.md +++ b/docs/docs/20-usage/30-matrix-workflows.md @@ -139,5 +139,5 @@ steps: ``` :::note -If you want to control the architecture of a pipeline on a Kubernetes runner, see [the nodeSelector documentation of the Kubernetes backend](../30-administration/22-backends/40-kubernetes.md#nodeSelector). +If you want to control the architecture of a pipeline on a Kubernetes runner, see [the nodeSelector documentation of the Kubernetes backend](../30-administration/22-backends/40-kubernetes.md#node-selector). ::: diff --git a/docs/docs/20-usage/51-plugins/20-creating-plugins.md b/docs/docs/20-usage/51-plugins/20-creating-plugins.md index adbb4df3e2..cd74ea4556 100644 --- a/docs/docs/20-usage/51-plugins/20-creating-plugins.md +++ b/docs/docs/20-usage/51-plugins/20-creating-plugins.md @@ -42,7 +42,7 @@ Values like this are converted to JSON and then passed to your plugin. In the ex ### Secrets -Secrets should be passed as settings too. Therefore, users should use [`from_secret`](../40-secrets.md#use-secrets-in-settings). +Secrets should be passed as settings too. Therefore, users should use [`from_secret`](../40-secrets.md#use-secrets-in-settings-and-environment). ## Plugin library diff --git a/docs/docs/30-administration/15-agent-config.md b/docs/docs/30-administration/15-agent-config.md index 31a37ab1c7..15792b38bd 100644 --- a/docs/docs/30-administration/15-agent-config.md +++ b/docs/docs/30-administration/15-agent-config.md @@ -178,7 +178,7 @@ See [Kubernetes backend configuration](./22-backends/40-kubernetes.md#configurat ### `WOODPECKER_BACKEND_LOCAL_*` -See [Local backend configuration](./22-backends/20-local.md#further-configuration) +See [Local backend configuration](./22-backends/20-local.md#options) ## Advanced Settings diff --git a/docs/docs/92-development/03-ui.md b/docs/docs/92-development/03-ui.md index 1fcf45ab46..e8999b0be8 100644 --- a/docs/docs/92-development/03-ui.md +++ b/docs/docs/92-development/03-ui.md @@ -11,7 +11,7 @@ Testing UI changes would require us to rebuild the UI after each adjustment to t ![UI Proxy architecture](./ui-proxy.svg) 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) section, you should now be able to access the UI under [http://localhost:8000](http://localhost:8000). +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). ## Tools and frameworks diff --git a/docs/package.json b/docs/package.json index f726f912de..09a5bba994 100644 --- a/docs/package.json +++ b/docs/package.json @@ -54,8 +54,7 @@ "pnpm": { "overrides": { "trim": "^0.0.3", - "got": "^11.8.5", - "follow-redirects@<1.15.4": ">=1.15.4" + "got": "^11.8.5" } } } diff --git a/docs/plugins/woodpecker-plugins/plugins.json b/docs/plugins/woodpecker-plugins/plugins.json index 564e84611d..1c96a40677 100644 --- a/docs/plugins/woodpecker-plugins/plugins.json +++ b/docs/plugins/woodpecker-plugins/plugins.json @@ -70,11 +70,6 @@ "docs": "https://raw.githubusercontent.com/ViViDboarder/drone-webdav/master/docs.md", "verified": false }, - { - "name": "Chart releaser", - "docs": "https://raw.githubusercontent.com/woodpecker-ci/plugin-chart-releaser/master/docs.md", - "verified": true - }, { "name": "Aptly publish", "docs": "https://gitea.zionetrix.net/bn8/aptly-publish/raw/branch/master/docs.md", @@ -189,6 +184,11 @@ "name": "Sonatype Nexus", "docs": "https://raw.githubusercontent.com/rockdrilla/woodpecker-sonatype-nexus/main/docs.md", "verified": false + }, + { + "name": "Mastodon Post", + "docs": "https://codeberg.org/woodpecker-plugins/mastodon-post/raw/branch/main/docs.md", + "verified": true } ] } diff --git a/docs/pnpm-lock.yaml b/docs/pnpm-lock.yaml index 9f75b680b2..0b92b5602d 100644 --- a/docs/pnpm-lock.yaml +++ b/docs/pnpm-lock.yaml @@ -7,7 +7,6 @@ settings: overrides: trim: ^0.0.3 got: ^11.8.5 - follow-redirects@<1.15.4: '>=1.15.4' importers: @@ -3815,7 +3814,7 @@ packages: /axios@1.6.7: resolution: {integrity: sha512-/hDJGff6/c7u0hDkvkGxR/oy6CbCs8ziCsC7SqmhjfozqiJGc8Z11wrv9z9lYfY4K8l+H9TpjcMDX0xOZmx+RA==} dependencies: - follow-redirects: 1.15.5(debug@4.3.4) + follow-redirects: 1.15.6(debug@4.3.4) form-data: 4.0.0 proxy-from-env: 1.1.0 transitivePeerDependencies: @@ -5347,8 +5346,8 @@ packages: resolution: {integrity: sha512-b6suED+5/3rTpUBdG1gupIl8MPFCAMA0QXwmljLhvCUKcUvdE4gWky9zpuGCcXHOsz4J9wPGNWq6OKpmIzz3hQ==} hasBin: true - /follow-redirects@1.15.5(debug@4.3.4): - resolution: {integrity: sha512-vSFWUON1B+yAw1VN4xMfxgn5fTUiaOzAJCKBwIIgT/+7CuGy9+r+5gITvP62j3RmaD5Ph65UaERdOSRGUzZtgw==} + /follow-redirects@1.15.6(debug@4.3.4): + resolution: {integrity: sha512-wWN62YITEaOpSK584EZXJafH1AGpO8RVgElfkuXbTOrPX4fIfOyEpW/CsiNd8JdYrAoOvafRTOEnvsO++qCqFA==} engines: {node: '>=4.0'} peerDependencies: debug: '*' @@ -5920,7 +5919,7 @@ packages: engines: {node: '>=8.0.0'} dependencies: eventemitter3: 4.0.7 - follow-redirects: 1.15.5(debug@4.3.4) + follow-redirects: 1.15.6(debug@4.3.4) requires-port: 1.0.0 transitivePeerDependencies: - debug diff --git a/docs/versioned_docs/version-0.15/30-administration/15-agent-config.md b/docs/versioned_docs/version-0.15/30-administration/15-agent-config.md index bf490bf087..865cc7805a 100644 --- a/docs/versioned_docs/version-0.15/30-administration/15-agent-config.md +++ b/docs/versioned_docs/version-0.15/30-administration/15-agent-config.md @@ -73,7 +73,7 @@ pipeline: ``` -See [Conditionals Pipeline](../20-usage/20-pipeline-syntax.md#step-when---conditional-execution) syntax for more +See [Conditionals Pipeline](../20-usage/22-conditional-execution.md) syntax for more ## All agent configuration options diff --git a/docs/versioned_docs/version-0.15/92-development/03-ui.md b/docs/versioned_docs/version-0.15/92-development/03-ui.md index 9491a7160a..636eca2900 100644 --- a/docs/versioned_docs/version-0.15/92-development/03-ui.md +++ b/docs/versioned_docs/version-0.15/92-development/03-ui.md @@ -1,6 +1,6 @@ # UI Development -To develop the UI you need to install [Node.js and Yarn](./01-getting-started.md#nodejs--yarn). In addition it is recommended to use VS-Code with the recommended plugin selection to get features like auto-formatting, linting and typechecking. The UI is written with [Vue 3](https://v3.vuejs.org/) as Single-Page-Application accessing the Woodpecker REST api. +To develop the UI you need to install [Node.js and Yarn](./01-getting-started.md#install-nodejs--yarn). In addition it is recommended to use VS-Code with the recommended plugin selection to get features like auto-formatting, linting and typechecking. The UI is written with [Vue 3](https://v3.vuejs.org/) as Single-Page-Application accessing the Woodpecker REST api. ## Setup The UI code is placed in `web/`. Change to that folder in your terminal with `cd web/` and install all dependencies by running `yarn install`. For production builds the generated UI code is integrated into the Woodpecker server by using [go-embed](https://pkg.go.dev/embed). @@ -10,7 +10,7 @@ Testing UI changes would require us to rebuild the UI after each adjustment to t ![UI Proxy architecture](./ui-proxy.svg) Start the UI server locally with [hot-reloading](https://stackoverflow.com/a/41429055/8461267) by running: `yarn 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) section, you should now be able to access the UI under [http://localhost:8000](http://localhost:8000). +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). ## Tools and frameworks diff --git a/docs/versioned_docs/version-0.15/92-development/04-docs.md b/docs/versioned_docs/version-0.15/92-development/04-docs.md index 5dbab03cef..21ee5436e0 100644 --- a/docs/versioned_docs/version-0.15/92-development/04-docs.md +++ b/docs/versioned_docs/version-0.15/92-development/04-docs.md @@ -2,7 +2,7 @@ The documentation is using docusaurus as framework. You can learn more about it from its [official documentation](https://docusaurus.io/docs/). -If you only want to change some text it probably is enough if you just search for the corresponding [Markdown](https://www.markdownguide.org/basic-syntax/) file inside the `docs/docs/` folder and adjust it. If you want to change larger parts and test the rendered documentation you can run docusaurus locally. Similarly to the UI you need to install [Node.js and Yarn](./01-getting-started.md#nodejs--yarn). After that you can run and build docusaurus locally by using the following commands: +If you only want to change some text it probably is enough if you just search for the corresponding [Markdown](https://www.markdownguide.org/basic-syntax/) file inside the `docs/docs/` folder and adjust it. If you want to change larger parts and test the rendered documentation you can run docusaurus locally. Similarly to the UI you need to install [Node.js and Yarn](./01-getting-started.md#install-nodejs--yarn). After that you can run and build docusaurus locally by using the following commands: ```bash cd docs/ diff --git a/docs/versioned_docs/version-1.0/92-development/03-ui.md b/docs/versioned_docs/version-1.0/92-development/03-ui.md index df121e4e18..b58ba1ed77 100644 --- a/docs/versioned_docs/version-1.0/92-development/03-ui.md +++ b/docs/versioned_docs/version-1.0/92-development/03-ui.md @@ -10,7 +10,7 @@ Testing UI changes would require us to rebuild the UI after each adjustment to t ![UI Proxy architecture](./ui-proxy.svg) 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) section, you should now be able to access the UI under [http://localhost:8000](http://localhost:8000). +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). ## Tools and frameworks diff --git a/docs/versioned_docs/version-2.0/20-usage/30-matrix-workflows.md b/docs/versioned_docs/version-2.0/20-usage/30-matrix-workflows.md index 9ec8851848..1abe0bcc58 100644 --- a/docs/versioned_docs/version-2.0/20-usage/30-matrix-workflows.md +++ b/docs/versioned_docs/version-2.0/20-usage/30-matrix-workflows.md @@ -139,5 +139,5 @@ steps: ``` :::note -If you want to control the architecture of a pipeline on a Kubernetes runner, see [the nodeSelector documentation of the Kubernetes backend](../30-administration/22-backends/40-kubernetes.md#nodeSelector). +If you want to control the architecture of a pipeline on a Kubernetes runner, see [the nodeSelector documentation of the Kubernetes backend](../30-administration/22-backends/40-kubernetes.md#nodeselector). ::: diff --git a/docs/versioned_docs/version-2.0/30-administration/10-server-config.md b/docs/versioned_docs/version-2.0/30-administration/10-server-config.md index 45606e43d9..c5f883be1e 100644 --- a/docs/versioned_docs/version-2.0/30-administration/10-server-config.md +++ b/docs/versioned_docs/version-2.0/30-administration/10-server-config.md @@ -605,7 +605,7 @@ Enable the Swagger UI for API documentation. ### `WOODPECKER_GITHUB_...` -See [GitHub configuration](forges/github/#configuration) +See [GitHub configuration](forges/github/#all-github-configuration-options) ### `WOODPECKER_GITEA_...` diff --git a/docs/versioned_docs/version-2.0/30-administration/15-agent-config.md b/docs/versioned_docs/version-2.0/30-administration/15-agent-config.md index e34348b043..6054affa22 100644 --- a/docs/versioned_docs/version-2.0/30-administration/15-agent-config.md +++ b/docs/versioned_docs/version-2.0/30-administration/15-agent-config.md @@ -186,7 +186,7 @@ See [Docker backend configuration](./22-backends/10-docker.md#configuration) ### `WOODPECKER_BACKEND_K8S_*` -See [Kubernetes backend configuration](./22-backends/40-kubernetes.md#configuration) +See [Kubernetes backend configuration](./22-backends/40-kubernetes.md#general-configuration) ### `WOODPECKER_BACKEND_LOCAL_*` diff --git a/docs/versioned_docs/version-2.0/92-development/03-ui.md b/docs/versioned_docs/version-2.0/92-development/03-ui.md index 1fcf45ab46..e8999b0be8 100644 --- a/docs/versioned_docs/version-2.0/92-development/03-ui.md +++ b/docs/versioned_docs/version-2.0/92-development/03-ui.md @@ -11,7 +11,7 @@ Testing UI changes would require us to rebuild the UI after each adjustment to t ![UI Proxy architecture](./ui-proxy.svg) 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) section, you should now be able to access the UI under [http://localhost:8000](http://localhost:8000). +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). ## Tools and frameworks diff --git a/docs/versioned_docs/version-2.1/20-usage/30-matrix-workflows.md b/docs/versioned_docs/version-2.1/20-usage/30-matrix-workflows.md index 9ec8851848..1abe0bcc58 100644 --- a/docs/versioned_docs/version-2.1/20-usage/30-matrix-workflows.md +++ b/docs/versioned_docs/version-2.1/20-usage/30-matrix-workflows.md @@ -139,5 +139,5 @@ steps: ``` :::note -If you want to control the architecture of a pipeline on a Kubernetes runner, see [the nodeSelector documentation of the Kubernetes backend](../30-administration/22-backends/40-kubernetes.md#nodeSelector). +If you want to control the architecture of a pipeline on a Kubernetes runner, see [the nodeSelector documentation of the Kubernetes backend](../30-administration/22-backends/40-kubernetes.md#nodeselector). ::: diff --git a/docs/versioned_docs/version-2.1/30-administration/15-agent-config.md b/docs/versioned_docs/version-2.1/30-administration/15-agent-config.md index 504265d36f..ab91a588f5 100644 --- a/docs/versioned_docs/version-2.1/30-administration/15-agent-config.md +++ b/docs/versioned_docs/version-2.1/30-administration/15-agent-config.md @@ -190,7 +190,7 @@ See [Docker backend configuration](./22-backends/10-docker.md#configuration) ### `WOODPECKER_BACKEND_K8S_*` -See [Kubernetes backend configuration](./22-backends/40-kubernetes.md#configuration) +See [Kubernetes backend configuration](./22-backends/40-kubernetes.md#general-configuration) ### `WOODPECKER_BACKEND_LOCAL_*` diff --git a/docs/versioned_docs/version-2.1/92-development/03-ui.md b/docs/versioned_docs/version-2.1/92-development/03-ui.md index 1fcf45ab46..e8999b0be8 100644 --- a/docs/versioned_docs/version-2.1/92-development/03-ui.md +++ b/docs/versioned_docs/version-2.1/92-development/03-ui.md @@ -11,7 +11,7 @@ Testing UI changes would require us to rebuild the UI after each adjustment to t ![UI Proxy architecture](./ui-proxy.svg) 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) section, you should now be able to access the UI under [http://localhost:8000](http://localhost:8000). +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). ## Tools and frameworks diff --git a/docs/versioned_docs/version-2.2/20-usage/30-matrix-workflows.md b/docs/versioned_docs/version-2.2/20-usage/30-matrix-workflows.md index c1c62c324f..8fd1e3f8b5 100644 --- a/docs/versioned_docs/version-2.2/20-usage/30-matrix-workflows.md +++ b/docs/versioned_docs/version-2.2/20-usage/30-matrix-workflows.md @@ -139,5 +139,5 @@ steps: ``` :::note -If you want to control the architecture of a pipeline on a Kubernetes runner, see [the nodeSelector documentation of the Kubernetes backend](../30-administration/22-backends/40-kubernetes.md#nodeSelector). +If you want to control the architecture of a pipeline on a Kubernetes runner, see [the nodeSelector documentation of the Kubernetes backend](../30-administration/22-backends/40-kubernetes.md#nodeselector). ::: diff --git a/docs/versioned_docs/version-2.2/30-administration/15-agent-config.md b/docs/versioned_docs/version-2.2/30-administration/15-agent-config.md index 26005eaf5a..4a3a5e5e00 100644 --- a/docs/versioned_docs/version-2.2/30-administration/15-agent-config.md +++ b/docs/versioned_docs/version-2.2/30-administration/15-agent-config.md @@ -184,7 +184,7 @@ See [Kubernetes backend configuration](./22-backends/40-kubernetes.md#configurat ### `WOODPECKER_BACKEND_LOCAL_*` -See [Local backend configuration](./22-backends/20-local.md#further-configuration) +See [Local backend configuration](./22-backends/20-local.md#options) ## Advanced Settings diff --git a/docs/versioned_docs/version-2.2/92-development/03-ui.md b/docs/versioned_docs/version-2.2/92-development/03-ui.md index 1fcf45ab46..e8999b0be8 100644 --- a/docs/versioned_docs/version-2.2/92-development/03-ui.md +++ b/docs/versioned_docs/version-2.2/92-development/03-ui.md @@ -11,7 +11,7 @@ Testing UI changes would require us to rebuild the UI after each adjustment to t ![UI Proxy architecture](./ui-proxy.svg) 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) section, you should now be able to access the UI under [http://localhost:8000](http://localhost:8000). +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). ## Tools and frameworks diff --git a/docs/versioned_docs/version-2.3/20-usage/30-matrix-workflows.md b/docs/versioned_docs/version-2.3/20-usage/30-matrix-workflows.md index a5ba107c9e..939530e6c1 100644 --- a/docs/versioned_docs/version-2.3/20-usage/30-matrix-workflows.md +++ b/docs/versioned_docs/version-2.3/20-usage/30-matrix-workflows.md @@ -139,5 +139,5 @@ steps: ``` :::note -If you want to control the architecture of a pipeline on a Kubernetes runner, see [the nodeSelector documentation of the Kubernetes backend](../30-administration/22-backends/40-kubernetes.md#nodeSelector). +If you want to control the architecture of a pipeline on a Kubernetes runner, see [the nodeSelector documentation of the Kubernetes backend](../30-administration/22-backends/40-kubernetes.md#nodeselector). ::: diff --git a/docs/versioned_docs/version-2.3/30-administration/15-agent-config.md b/docs/versioned_docs/version-2.3/30-administration/15-agent-config.md index 26005eaf5a..4a3a5e5e00 100644 --- a/docs/versioned_docs/version-2.3/30-administration/15-agent-config.md +++ b/docs/versioned_docs/version-2.3/30-administration/15-agent-config.md @@ -184,7 +184,7 @@ See [Kubernetes backend configuration](./22-backends/40-kubernetes.md#configurat ### `WOODPECKER_BACKEND_LOCAL_*` -See [Local backend configuration](./22-backends/20-local.md#further-configuration) +See [Local backend configuration](./22-backends/20-local.md#options) ## Advanced Settings diff --git a/docs/versioned_docs/version-2.3/92-development/03-ui.md b/docs/versioned_docs/version-2.3/92-development/03-ui.md index 1fcf45ab46..e8999b0be8 100644 --- a/docs/versioned_docs/version-2.3/92-development/03-ui.md +++ b/docs/versioned_docs/version-2.3/92-development/03-ui.md @@ -11,7 +11,7 @@ Testing UI changes would require us to rebuild the UI after each adjustment to t ![UI Proxy architecture](./ui-proxy.svg) 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) section, you should now be able to access the UI under [http://localhost:8000](http://localhost:8000). +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). ## Tools and frameworks