Add prettier to docs/ (#4628)

.prettierignore

@@ -1,10 +1,8 @@
 build/
-docs/versioned_docs/
-docs/.docusaurus/
-docs/pnpm-lock.yaml
 dist/
 CHANGELOG.md
 
-# web/ must be directly formatted from there
+# web/ and docs/ must be directly formatted from there
 # to prevent conflicts with different prettier version
 web/
+docs/

.woodpecker/docs.yaml

@@ -37,10 +37,17 @@ when:
     evaluate: 'TASK == "docs"'
 
 steps:
+  prettier:
+    image: docker.io/woodpeckerci/plugin-prettier:1.0.0
+    depends_on: []
+    settings:
+      version: 3.3.3
+
   build-cli:
     image: *golang_image
     commands:
       - make docs
+    depends_on: prettier
     when:
       - path: *when_path
         event: [tag, pull_request, push]
@@ -53,6 +60,9 @@ steps:
       - corepack enable
       - pnpm install --frozen-lockfile
       - pnpm build
+    depends_on:
+      - prettier
+      - build-cli
     when:
       - path: *when_path
         event: [tag, pull_request, push]
@@ -67,6 +77,9 @@ steps:
       forge_repo_token:
         from_secret: GITHUB_TOKEN_SURGE
     failure: ignore
+    depends_on:
+      - prettier
+      - build
     when:
       event: [pull_request, pull_request_closed]
       path: *when_path
@@ -83,6 +96,9 @@ steps:
       - echo "$BOT_PRIVATE_KEY" > $HOME/.ssh/id_rsa
       - chmod 0600 $HOME/.ssh/id_rsa
       - git clone --depth 1 --single-branch git@github.com:woodpecker-ci/woodpecker-ci.github.io.git ./docs_repo
+    depends_on:
+      - prettier
+      - build
     when:
       - event: push
         path:
@@ -98,6 +114,9 @@ steps:
       - apk add jq
       - jq '.next = "next-${CI_COMMIT_SHA:0:10}"' ./docs_repo/version.json > ./docs_repo/version.json.tmp
       - mv ./docs_repo/version.json.tmp ./docs_repo/version.json
+    depends_on:
+      - prettier
+      - deploy-prepare
     when:
       - event: push
         path: *docker_path
@@ -110,6 +129,9 @@ steps:
       - if [[ "${CI_COMMIT_TAG}" != *"rc"* ]] ; then jq '.latest = "${CI_COMMIT_TAG}"' ./docs_repo/version.json > ./docs_repo/version.json.tmp && mv ./docs_repo/version.json.tmp ./docs_repo/version.json ; fi
       - jq '.rc = "${CI_COMMIT_TAG}"' ./docs_repo/version.json > ./docs_repo/version.json.tmp
       - mv ./docs_repo/version.json.tmp ./docs_repo/version.json
+    depends_on:
+      - prettier
+      - deploy-prepare
     when:
       - event: tag
 
@@ -119,6 +141,8 @@ steps:
       - apk add rsync
       # copy all docs files and delete all old ones, but leave CNAME, index.yaml and version.json untouched
       - rsync -r --exclude .git --exclude CNAME --exclude index.yaml --exclude README.md --exclude version.json --delete docs/build/ ./docs_repo
+    depends_on:
+      - prettier
     when:
       - event: push
         path: *when_path
@@ -144,6 +168,9 @@ steps:
       - test -n "$(git status --porcelain)" || exit 0
       - git commit -m "Deploy website - based on ${CI_COMMIT_SHA}"
       - git push
+    depends_on:
+      - prettier
+      - copy-files
     when:
       - event: push
         path:

docs/.prettierignore

@@ -0,0 +1,7 @@
+pnpm-lock.yaml
+dist
+coverage/
+LICENSE
+components.d.ts
+src/assets/locales/*.json
+!src/assets/locales/en.json

docs/.prettierrc.js

@@ -0,0 +1,16 @@
+import { readFile } from 'node:fs/promises';
+
+// eslint-disable-next-line antfu/no-top-level-await
+const config = JSON.parse(await readFile(new URL('../.prettierrc.json', import.meta.url)));
+
+export default {
+  ...config,
+  plugins: ['@ianvs/prettier-plugin-sort-imports'],
+  importOrder: [
+    '<THIRD_PARTY_MODULES>', // Imports not matched by other special words or groups.
+    '', // Empty string will match any import not matched by other special words or groups.
+    '^(#|@|~|\\$)(/.*)$',
+    '',
+    '^[./]',
+  ],
+};

docs/docusaurus.config.ts

@@ -1,7 +1,7 @@
-import { themes } from 'prism-react-renderer';
-import type { Config } from '@docusaurus/types';
-import type * as Preset from '@docusaurus/preset-classic';
 import * as path from 'path';
+import type * as Preset from '@docusaurus/preset-classic';
+import type { Config } from '@docusaurus/types';
+import { themes } from 'prism-react-renderer';
 
 const config = {
   title: 'Woodpecker CI',

docs/plugins/woodpecker-plugins/src/index.ts

@@ -1,9 +1,10 @@
-import { LoadContext, Plugin, PluginContentLoadedActions } from '@docusaurus/types';
-import path from 'path';
 import fs from 'fs';
+import path from 'path';
+import { LoadContext, Plugin, PluginContentLoadedActions } from '@docusaurus/types';
 import axios, { AxiosError } from 'axios';
-import { Content, WoodpeckerPlugin, WoodpeckerPluginHeader, WoodpeckerPluginIndexEntry } from './types';
+
 import * as markdown from './markdown';
+import { Content, WoodpeckerPlugin, WoodpeckerPluginHeader, WoodpeckerPluginIndexEntry } from './types';
 
 async function loadContent(): Promise<Content> {
   const file = path.join(__dirname, '..', 'plugins.json');

docs/plugins/woodpecker-plugins/src/theme/WoodpeckerPlugin.tsx

@@ -1,5 +1,6 @@
-import React from 'react';
 import Layout from '@theme/Layout';
+import React from 'react';
+
 import { WoodpeckerPlugin as WoodpeckerPluginType } from '../types';
 import { IconContainer, IconPlugin, IconVerified, IconWebsite } from './Icons';
 

docs/plugins/woodpecker-plugins/src/theme/WoodpeckerPluginList.tsx

@@ -1,7 +1,9 @@
-import React, { useState, useRef } from 'react';
-import Fuse from 'fuse.js';
 import Layout from '@theme/Layout';
+import Fuse from 'fuse.js';
+import React, { useRef, useState } from 'react';
+
 import './style.css';
+
 import { WoodpeckerPlugin } from '../types';
 import { IconPlugin, IconVerified } from './Icons';
 

docs/plugins/woodpecker-plugins/src/theme/style.css

@@ -57,8 +57,8 @@
   padding: 1rem 1rem 1rem 2.25rem;
   font-size: 1.1rem;
   appearance: none;
-  background: var(--ifm-navbar-search-input-background-color) var(--ifm-navbar-search-input-icon) no-repeat 0.75rem 1rem /
+  background: var(--ifm-navbar-search-input-background-color) var(--ifm-navbar-search-input-icon) no-repeat 0.75rem
-    1.1rem 1.1rem;
+    1rem / 1.1rem 1.1rem;
   border-radius: 0.5rem;
   border: 1px solid var(--ifm-card-background-color);
   color: var(--ifm-navbar-search-input-color);

docs/src/components/HomepageFeatures.js

@@ -1,5 +1,6 @@
-import React from 'react';
 import clsx from 'clsx';
+import React from 'react';
+
 import styles from './HomepageFeatures.module.css';
 
 const FeatureList = [

docs/src/pages/index.tsx

@@ -1,10 +1,11 @@
-import React from 'react';
-import clsx from 'clsx';
-import Layout from '@theme/Layout';
 import Link from '@docusaurus/Link';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-import styles from './index.module.css';
+import Layout from '@theme/Layout';
+import clsx from 'clsx';
+import React from 'react';
+
 import HomepageFeatures from '../components/HomepageFeatures';
+import styles from './index.module.css';
 
 function HomepageHeader() {
   const { siteConfig } = useDocusaurusContext();

docs/versioned_docs/version-1.0/20-usage/20-pipeline-syntax.md

@@ -427,14 +427,14 @@ Execute a step only when certain files were changed:
 
 ```yaml
 when:
-  - path: "src/*.js"
+  - path: 'src/*.js'
 ```
 
 One can also use [glob patterns](https://github.com/bmatcuk/doublestar#patterns):
 
 ```yaml
 when:
-  - path: "src/**/*.js"
+  - path: 'src/**/*.js'
 ```
 
 To match whether the files have been changed or not changed, use `include` or `exclude` respectively:
@@ -444,7 +444,7 @@ when:
   - path:
       include: ['.woodpecker/*.yml', '*.ini']
       exclude: ['*.md', 'docs/**']
-      ignore_message: "[ALL]"
+      ignore_message: '[ALL]'
 ```
 
 **Hint:** Passing a defined ignore-message like `[ALL]` inside the commit message will ignore all path conditions.

docs/versioned_docs/version-1.0/20-usage/35-advanced-yaml-syntax.md

@@ -5,6 +5,7 @@
 You can use [YAML anchors & aliases](https://yaml.org/spec/1.2.2/#3222-anchors-and-aliases) as variables in your pipeline config.
 
 To convert this:
+
 ```yml
 steps:
   test:

docs/versioned_docs/version-1.0/20-usage/40-secrets.md

@@ -28,7 +28,6 @@ steps:
 +       from_secret: secret_token
 ```
 
-
 Please note parameter expressions are subject to pre-processing. When using secrets in parameter expressions they should be escaped.
 
 ```diff
@@ -84,7 +83,7 @@ Please be careful when exposing secrets to pull requests. If your repository is
 To prevent abusing your secrets with malicious pull requests, you can limit a secret to a list of images. They are not available to any other container. In addition, you can make the secret available only for plugins (steps without user-defined commands).
 
 :::warning
-If you enable the option "Only available for plugins", always set an image filter too. Otherwise, the secret can be accessed by a very simple self-developed plugin and is thus *not* safe.
+If you enable the option "Only available for plugins", always set an image filter too. Otherwise, the secret can be accessed by a very simple self-developed plugin and is thus _not_ safe.
 If you only set an image filter, you could still access the secret using the same image and by specifying a command that prints it.
 :::
 

docs/versioned_docs/version-1.0/20-usage/90-pipeline-management.md

@@ -57,8 +57,7 @@ One can create a file containing environment variables, and then source it in ea
 steps:
   init:
     image: bash
-    commands:
+    commands: echo "FOO=hello" >> envvars
-      echo "FOO=hello" >> envvars
       echo "BAR=world" >> envvars
 
   debug:

docs/versioned_docs/version-1.0/30-administration/10-server-config.md

@@ -154,6 +154,7 @@ WOODPECKER_CUSTOM_CSS_FILE=/usr/local/www/woodpecker.js
 The examples below show how to place a banner message in the top navigation bar of Woodpecker.
 
 ##### woodpecker.css
+
 ```css
 .banner-message {
   position: absolute;
@@ -172,44 +173,52 @@ The examples below show how to place a banner message in the top navigation bar
 
 ```javascript
 // place/copy a minified version of jQuery or ZeptoJS here ...
-!function(){"use strict";function e(){};/*...*/}();
+!(function () {
+  'use strict';
+  function e() {} /*...*/
+})();
 
 $().ready(function () {
-    $(".app nav img").first().htmlAfter("<div class='banner-message'>This is a demo banner message :)</div>")
+  $('.app nav img').first().htmlAfter("<div class='banner-message'>This is a demo banner message :)</div>");
 });
 ```
 
-
 ## All server configuration options
 
 The following list describes all available server configuration options.
 
 ### `WOODPECKER_LOG_LEVEL`
+
 > Default: empty
 
 Configures the logging level. Possible values are `trace`, `debug`, `info`, `warn`, `error`, `fatal`, `panic`, `disabled` and empty.
 
 ### `WOODPECKER_LOG_XORM`
+
 > Default: `false`
 
 Enable XORM logs.
 
 ### `WOODPECKER_LOG_XORM_SQL`
+
 > Default: `false`
 
 Enable XORM SQL command logs.
 
 ### `WOODPECKER_DEBUG_PRETTY`
+
 > Default: `false`
 
 Enable pretty-printed debug output.
 
 ### `WOODPECKER_DEBUG_NOCOLOR`
+
 > Default: `true`
 
 Disable colored debug output.
 
 ### `WOODPECKER_HOST`
+
 > Default: empty
 
 Server fully qualified URL of the user-facing hostname.
@@ -217,6 +226,7 @@ Server fully qualified URL of the user-facing hostname.
 Example: `WOODPECKER_HOST=http://woodpecker.example.org`
 
 ### `WOODPECKER_WEBHOOK_HOST`
+
 > Default: value from `WOODPECKER_HOST` config env
 
 Server fully qualified URL of the Webhook-facing hostname.
@@ -224,16 +234,19 @@ Server fully qualified URL of the Webhook-facing hostname.
 Example: `WOODPECKER_WEBHOOK_HOST=http://woodpecker-server.cicd.svc.cluster.local:8000`
 
 ### `WOODPECKER_SERVER_ADDR`
+
 > Default: `:8000`
 
 Configures the HTTP listener port.
 
 ### `WOODPECKER_SERVER_ADDR_TLS`
+
 > Default: `:443`
 
 Configures the HTTPS listener port when SSL is enabled.
 
 ### `WOODPECKER_SERVER_CERT`
+
 > Default: empty
 
 Path to an SSL certificate used by the server to accept HTTPS requests.
@@ -241,6 +254,7 @@ Path to an SSL certificate used by the server to accept HTTPS requests.
 Example: `WOODPECKER_SERVER_CERT=/path/to/cert.pem`
 
 ### `WOODPECKER_SERVER_KEY`
+
 > Default: empty
 
 Path to an SSL certificate key used by the server to accept HTTPS requests.
@@ -248,6 +262,7 @@ Path to an SSL certificate key used by the server to accept HTTPS requests.
 Example: `WOODPECKER_SERVER_KEY=/path/to/key.pem`
 
 ### `WOODPECKER_CUSTOM_CSS_FILE`
+
 > Default: empty
 
 File path for the server to serve a custom .CSS file, used for customizing the UI.
@@ -257,6 +272,7 @@ The file must be UTF-8 encoded, to ensure all special characters are preserved.
 Example: `WOODPECKER_CUSTOM_CSS_FILE=/usr/local/www/woodpecker.css`
 
 ### `WOODPECKER_CUSTOM_JS_FILE`
+
 > Default: empty
 
 File path for the server to serve a custom .JS file, used for customizing the UI.
@@ -266,26 +282,31 @@ The file must be UTF-8 encoded, to ensure all special characters are preserved.
 Example: `WOODPECKER_CUSTOM_JS_FILE=/usr/local/www/woodpecker.js`
 
 ### `WOODPECKER_LETS_ENCRYPT`
+
 > Default: `false`
 
 Automatically generates an SSL certificate using Let's Encrypt, and configures the server to accept HTTPS requests.
 
 ### `WOODPECKER_GRPC_ADDR`
+
 > Default: `:9000`
 
 Configures the gRPC listener port.
 
 ### `WOODPECKER_GRPC_SECRET`
+
 > Default: `secret`
 
 Configures the gRPC JWT secret.
 
 ### `WOODPECKER_GRPC_SECRET_FILE`
+
 > Default: empty
 
 Read the value for `WOODPECKER_GRPC_SECRET` from the specified filepath.
 
 ### `WOODPECKER_METRICS_SERVER_ADDR`
+
 > Default: empty
 
 Configures an unprotected metrics endpoint. An empty value disables the metrics endpoint completely.
@@ -293,6 +314,7 @@ Configures an unprotected metrics endpoint. An empty value disables the metrics
 Example: `:9001`
 
 ### `WOODPECKER_ADMIN`
+
 > Default: empty
 
 Comma-separated list of admin accounts.
@@ -300,6 +322,7 @@ Comma-separated list of admin accounts.
 Example: `WOODPECKER_ADMIN=user1,user2`
 
 ### `WOODPECKER_ORGS`
+
 > Default: empty
 
 Comma-separated list of approved organizations.
@@ -307,6 +330,7 @@ Comma-separated list of approved organizations.
 Example: `org1,org2`
 
 ### `WOODPECKER_REPO_OWNERS`
+
 > Default: empty
 
 Comma-separated list of syncable repo owners. ???
@@ -314,41 +338,49 @@ Comma-separated list of syncable repo owners. ???
 Example: `user1,user2`
 
 ### `WOODPECKER_OPEN`
+
 > Default: `false`
 
 Enable to allow user registration.
 
 ### `WOODPECKER_DOCS`
+
 > Default: `https://woodpecker-ci.org/`
 
 Link to documentation in the UI.
 
 ### `WOODPECKER_AUTHENTICATE_PUBLIC_REPOS`
+
 > Default: `false`
 
 Always use authentication to clone repositories even if they are public. Needed if the forge requires to always authenticate as used by many companies.
 
 ### `WOODPECKER_DEFAULT_CANCEL_PREVIOUS_PIPELINE_EVENTS`
+
 > Default: `pull_request, push`
 
 List of event names that will be canceled when a new pipeline for the same context (tag, branch) is created.
 
 ### `WOODPECKER_DEFAULT_CLONE_IMAGE`
+
 > Default is defined in [shared/constant/constant.go](https://github.com/woodpecker-ci/woodpecker/blob/master/shared/constant/constant.go)
 
 The default docker image to be used when cloning the repo
 
 ### `WOODPECKER_DEFAULT_PIPELINE_TIMEOUT`
+
 > 60 (minutes)
 
 The default time for a repo in minutes before a pipeline gets killed
 
 ### `WOODPECKER_MAX_PIPELINE_TIMEOUT`
+
 > 120 (minutes)
 
 The maximum time in minutes you can set in the repo settings before a pipeline gets killed
 
 ### `WOODPECKER_SESSION_EXPIRES`
+
 > Default: `72h`
 
 Configures the session expiration time.
@@ -357,6 +389,7 @@ As long as the session is valid (until it expires or log-out),
 a user can log into Woodpecker, without re-authentication.
 
 ### `WOODPECKER_ESCALATE`
+
 > Defaults are defined in [shared/constant/constant.go](https://github.com/woodpecker-ci/woodpecker/blob/master/shared/constant/constant.go)
 
 Docker images to run in privileged mode. Only change if you are sure what you do!
@@ -371,6 +404,7 @@ Example: `WOODPECKER_VOLUME=/path/on/host:/path/in/container:rw`|
 -->
 
 ### `WOODPECKER_DOCKER_CONFIG`
+
 > Default: empty
 
 Configures a specific private registry config for all pipelines.
@@ -392,16 +426,19 @@ Example: `WOODPECKER_NETWORK=network1,network2`
 -->
 
 ### `WOODPECKER_AGENT_SECRET`
+
 > Default: empty
 
 A shared secret used by server and agents to authenticate communication. A secret can be generated by `openssl rand -hex 32`.
 
 ### `WOODPECKER_AGENT_SECRET_FILE`
+
 > Default: empty
 
 Read the value for `WOODPECKER_AGENT_SECRET` from the specified filepath
 
 ### `WOODPECKER_KEEPALIVE_MIN_TIME`
+
 > Default: empty
 
 Server-side enforcement policy on the minimum amount of time a client should wait before sending a keepalive ping.
@@ -409,16 +446,19 @@ Server-side enforcement policy on the minimum amount of time a client should wai
 Example: `WOODPECKER_KEEPALIVE_MIN_TIME=10s`
 
 ### `WOODPECKER_DATABASE_DRIVER`
+
 > Default: `sqlite3`
 
 The database driver name. Possible values are `sqlite3`, `mysql` or `postgres`.
 
 ### `WOODPECKER_DATABASE_DATASOURCE`
+
 > Default: `woodpecker.sqlite`
 
 The database connection string. The default value is the path of the embedded SQLite database file.
 
 Example:
+
 ```bash
 # MySQL
 # https://github.com/go-sql-driver/mysql#dsn-data-source-name
@@ -430,47 +470,56 @@ WOODPECKER_DATABASE_DATASOURCE=postgres://root:password@1.2.3.4:5432/woodpecker?
 ```
 
 ### `WOODPECKER_DATABASE_DATASOURCE_FILE`
+
 > Default: empty
 
 Read the value for `WOODPECKER_DATABASE_DATASOURCE` from the specified filepath
 
 ### `WOODPECKER_ENCRYPTION_KEY`
+
 > Default: empty
 
 Encryption key used to encrypt secrets in DB. See [secrets encryption](./40-encryption.md)
 
 ### `WOODPECKER_ENCRYPTION_KEY_FILE`
+
 > Default: empty
 
 Read the value for `WOODPECKER_ENCRYPTION_KEY` from the specified filepath
 
 ### `WOODPECKER_ENCRYPTION_TINK_KEYSET_FILE`
+
 > Default: empty
 
 Filepath to encryption keyset used to encrypt secrets in DB. See [secrets encryption](./40-encryption.md)
 
 ### `WOODPECKER_ENCRYPTION_DISABLE`
+
 > Default: empty
 
 Boolean flag to decrypt secrets in DB and disable server encryption. See [secrets encryption](./40-encryption.md)
 
 ### `WOODPECKER_PROMETHEUS_AUTH_TOKEN`
+
 > Default: empty
 
 Token to secure the Prometheus metrics endpoint.
 Must be set to enable the endpoint.
 
 ### `WOODPECKER_PROMETHEUS_AUTH_TOKEN_FILE`
+
 > Default: empty
 
 Read the value for `WOODPECKER_PROMETHEUS_AUTH_TOKEN` from the specified filepath
 
 ### `WOODPECKER_STATUS_CONTEXT`
+
 > Default: `ci/woodpecker`
 
 Context prefix Woodpecker will use to publish status messages to SCM. You probably will only need to change it if you run multiple Woodpecker instances for a single repository.
 
 ### `WOODPECKER_STATUS_CONTEXT_FORMAT`
+
 > Default: `{{ .context }}/{{ .event }}/{{ .workflow }}`
 
 Template for the status messages published to forges, uses [Go templates](https://pkg.go.dev/text/template) as template language.
@@ -485,50 +534,57 @@ Supported variables:
 ---
 
 ### `WOODPECKER_LIMIT_MEM_SWAP`
+
 > Default: `0`
 
 The maximum amount of memory a single pipeline container is allowed to swap to disk, configured in bytes. There is no limit if `0`.
 
 ### `WOODPECKER_LIMIT_MEM`
+
 > Default: `0`
 
 The maximum amount of memory a single pipeline container can use, configured in bytes. There is no limit if `0`.
 
 ### `WOODPECKER_LIMIT_SHM_SIZE`
+
 > Default: `0`
 
 The maximum amount of memory of `/dev/shm` allowed in bytes. There is no limit if `0`.
 
 ### `WOODPECKER_LIMIT_CPU_QUOTA`
+
 > Default: `0`
 
 The number of microseconds per CPU period that the container is limited to before throttled. There is no limit if `0`.
 
 ### `WOODPECKER_LIMIT_CPU_SHARES`
+
 > Default: `0`
 
 The relative weight vs. other containers.
 
 ### `WOODPECKER_LIMIT_CPU_SET`
+
 > Default: empty
 
 Comma-separated list to limit the specific CPUs or cores a pipeline container can use.
 
 Example: `WOODPECKER_LIMIT_CPU_SET=1,2`
 
-
 ### `WOODPECKER_CONFIG_SERVICE_ENDPOINT`
+
 > Default: ``
 
 Specify a configuration service endpoint, see [Configuration Extension](./100-external-configuration-api.md)
 
-
 ### `WOODPECKER_FORGE_TIMEOUT`
+
 > Default: 3sec
 
 Specify how many seconds before timeout when fetching the Woodpecker configuration from a Forge
 
 ### `WOODPECKER_ROOT_URL`
+
 > Default: ``
 
 Server URL path prefix (used for statics loading when having a url path prefix), should start with `/`

docs/versioned_docs/version-1.0/30-administration/100-external-configuration-api.md

@@ -52,9 +52,7 @@ WOODPECKER_CONFIG_SERVICE_ENDPOINT=https://example.com/ciconfig
     "author_avatar": "https://myforge.com/avatars/d6b3f7787a685fcdf2a44e2c685c7e03",
     "author_email": "my@email.com",
     "branch": "master",
-    "changed_files": [
+    "changed_files": ["somefilename.txt"],
-      "somefilename.txt"
-    ],
     "commit": "2fff90f8d288a4640e90f05049fe30e61a14fd50",
     "created_at": 0,
     "deploy_to": "",

docs/versioned_docs/version-1.0/30-administration/11-forges/10-overview.md

@@ -3,7 +3,7 @@
 ## Supported features
 
 | Feature                                                       | [GitHub](github/)  | [Gitea / Forgejo](gitea/) | [Gitlab](gitlab/)  | [Bitbucket](bitbucket/) |
-| --- | :---: | :---: | :---: | :---: |
+| ------------------------------------------------------------- | :----------------: | :-----------------------: | :----------------: | :---------------------: |
 | Event: Push                                                   | :white_check_mark: |    :white_check_mark:     | :white_check_mark: |   :white_check_mark:    |
 | Event: Tag                                                    | :white_check_mark: |    :white_check_mark:     | :white_check_mark: |   :white_check_mark:    |
 | Event: Pull-Request                                           | :white_check_mark: |    :white_check_mark:     | :white_check_mark: |   :white_check_mark:    |

docs/versioned_docs/version-1.0/30-administration/11-forges/20-github.md

@@ -32,41 +32,49 @@ Please use this screenshot for reference:
 This is a full list of configuration options. Please note that many of these options use default configuration values that should work for the majority of installations.
 
 ### `WOODPECKER_GITHUB`
+
 > Default: `false`
 
 Enables the GitHub driver.
 
 ### `WOODPECKER_GITHUB_URL`
+
 > Default: `https://github.com`
 
 Configures the GitHub server address.
 
 ### `WOODPECKER_GITHUB_CLIENT`
+
 > Default: empty
 
 Configures the GitHub OAuth client id. This is used to authorize access.
 
 ### `WOODPECKER_GITHUB_CLIENT_FILE`
+
 > Default: empty
 
 Read the value for `WOODPECKER_GITHUB_CLIENT` from the specified filepath
 
 ### `WOODPECKER_GITHUB_SECRET`
+
 > Default: empty
 
 Configures the GitHub OAuth client secret. This is used to authorize access.
 
 ### `WOODPECKER_GITHUB_SECRET_FILE`
+
 > Default: empty
 
 Read the value for `WOODPECKER_GITHUB_SECRET` from the specified filepath
 
 ### `WOODPECKER_GITHUB_MERGE_REF`
+
 > Default: `true`
 
 TODO
 
 ### `WOODPECKER_GITHUB_SKIP_VERIFY`
+
 > Default: `false`
 
 Configure if SSL verification should be skipped.

docs/versioned_docs/version-1.0/30-administration/11-forges/30-gitea.md

@@ -25,51 +25,59 @@ services:
 Register your application with Gitea to create your client id and secret. You can find the OAuth applications settings of Gitea at `https://gitea.<host>/user/settings/`. It is very import the authorization callback URL matches your http(s) scheme and hostname exactly with `https://<host>/authorize` as the path.
 
 If you run the Woodpecker CI server on the same host as the Gitea instance, you might also need to allow local connections in Gitea, since version `v1.16`. Otherwise webhooks will fail. Add the following lines to your Gitea configuration (usually at `/etc/gitea/conf/app.ini`).
+
 ```ini
 ...
 [webhook]
 ALLOWED_HOST_LIST=external,loopback
 ```
+
 For reference see [Configuration Cheat Sheet](https://docs.gitea.io/en-us/config-cheat-sheet/#webhook-webhook).
 
 ![gitea oauth setup](gitea_oauth.gif)
 
-
 ## Configuration
 
 This is a full list of configuration options. Please note that many of these options use default configuration values that should work for the majority of installations.
 
 ### `WOODPECKER_GITEA`
+
 > Default: `false`
 
 Enables the Gitea driver.
 
 ### `WOODPECKER_GITEA_URL`
+
 > Default: `https://try.gitea.io`
 
 Configures the Gitea server address.
 
 ### `WOODPECKER_GITEA_CLIENT`
+
 > Default: empty
 
 Configures the Gitea OAuth client id. This is used to authorize access.
 
 ### `WOODPECKER_GITEA_CLIENT_FILE`
+
 > Default: empty
 
 Read the value for `WOODPECKER_GITEA_CLIENT` from the specified filepath
 
 ### `WOODPECKER_GITEA_SECRET`
+
 > Default: empty
 
 Configures the Gitea OAuth client secret. This is used to authorize access.
 
 ### `WOODPECKER_GITEA_SECRET_FILE`
+
 > Default: empty
 
 Read the value for `WOODPECKER_GITEA_SECRET` from the specified filepath
 
 ### `WOODPECKER_GITEA_SKIP_VERIFY`
+
 > Default: `false`
 
 Configure if SSL verification should be skipped.

docs/versioned_docs/version-1.0/30-administration/11-forges/40-gitlab.md

@@ -32,36 +32,43 @@ If you run the Woodpecker CI server on the same host as the GitLab instance, you
 This is a full list of configuration options. Please note that many of these options use default configuration values that should work for the majority of installations.
 
 ### `WOODPECKER_GITLAB`
+
 > Default: `false`
 
 Enables the GitLab driver.
 
 ### `WOODPECKER_GITLAB_URL`
+
 > Default: `https://gitlab.com`
 
 Configures the GitLab server address.
 
 ### `WOODPECKER_GITLAB_CLIENT`
+
 > Default: empty
 
 Configures the GitLab OAuth client id. This is used to authorize access.
 
 ### `WOODPECKER_GITLAB_CLIENT_FILE`
+
 > Default: empty
 
 Read the value for `WOODPECKER_GITLAB_CLIENT` from the specified filepath
 
 ### `WOODPECKER_GITLAB_SECRET`
+
 > Default: empty
 
 Configures the GitLab OAuth client secret. This is used to authorize access.
 
 ### `WOODPECKER_GITLAB_SECRET_FILE`
+
 > Default: empty
 
 Read the value for `WOODPECKER_GITLAB_SECRET` from the specified filepath
 
 ### `WOODPECKER_GITLAB_SKIP_VERIFY`
+
 > Default: `false`
 
 Configure if SSL verification should be skipped.

docs/versioned_docs/version-1.0/30-administration/11-forges/50-bitbucket.md

@@ -44,26 +44,31 @@ Webhooks:Read and Write
 This is a full list of configuration options. Please note that many of these options use default configuration values that should work for the majority of installations.
 
 ### `WOODPECKER_BITBUCKET`
+
 > Default: `false`
 
 Enables the Bitbucket driver.
 
 ### `WOODPECKER_BITBUCKET_CLIENT`
+
 > Default: empty
 
 Configures the Bitbucket OAuth client id. This is used to authorize access.
 
 ### `WOODPECKER_BITBUCKET_CLIENT_FILE`
+
 > Default: empty
 
 Read the value for `WOODPECKER_BITBUCKET_CLIENT` from the specified filepath
 
 ### `WOODPECKER_BITBUCKET_SECRET`
+
 > Default: empty
 
 Configures the Bitbucket OAuth client secret. This is used to authorize access.
 
 ### `WOODPECKER_BITBUCKET_SECRET_FILE`
+
 > Default: empty
 
 Read the value for `WOODPECKER_BITBUCKET_SECRET` from the specified filepath

docs/versioned_docs/version-1.0/30-administration/15-agent-config.md

@@ -76,91 +76,109 @@ At following startups Agent uses own token only.
 Here is the full list of configuration options and their default variables.
 
 ### `WOODPECKER_SERVER`
+
 > Default: `localhost:9000`
 
 Configures gRPC address of the server.
 
 ### `WOODPECKER_USERNAME`
+
 > Default: `x-oauth-basic`
 
 The gRPC username.
 
 ### `WOODPECKER_AGENT_SECRET`
+
 > Default: empty
 
 A shared secret used by server and agents to authenticate communication. A secret can be generated by `openssl rand -hex 32`.
 
 ### `WOODPECKER_AGENT_SECRET_FILE`
+
 > Default: empty
 
 Read the value for `WOODPECKER_AGENT_SECRET` from the specified filepath, e.g. `/etc/woodpecker/agent-secret.conf`
 
 ### `WOODPECKER_LOG_LEVEL`
+
 > Default: empty
 
 Configures the logging level. Possible values are `trace`, `debug`, `info`, `warn`, `error`, `fatal`, `panic`, `disabled` and empty.
 
 ### `WOODPECKER_DEBUG_PRETTY`
+
 > Default: `false`
 
 Enable pretty-printed debug output.
 
 ### `WOODPECKER_DEBUG_NOCOLOR`
+
 > Default: `true`
 
 Disable colored debug output.
 
 ### `WOODPECKER_HOSTNAME`
+
 > Default: empty
 
 Configures the agent hostname.
 
 ### `WOODPECKER_AGENT_CONFIG_FILE`
+
 > Default: `/etc/woodpecker/agent.conf`
 
 Configures the path of the agent config file.
 
 ### `WOODPECKER_MAX_WORKFLOWS`
+
 > Default: `1`
 
 Configures the number of parallel workflows.
 
 ### `WOODPECKER_FILTER_LABELS`
+
 > Default: empty
 
 Configures labels to filter pipeline pick up. Use a list of key-value pairs like `key=value,second-key=*`. `*` can be used as a wildcard. By default agents provide three additional labels `platform=os/arch`, `hostname=my-agent` and `repo=*` which can be overwritten if needed. To learn how labels work check out the [pipeline syntax page](../20-usage/20-pipeline-syntax.md#labels).
 
 ### `WOODPECKER_HEALTHCHECK`
+
 > Default: `true`
 
 Enable healthcheck endpoint.
 
 ### `WOODPECKER_HEALTHCHECK_ADDR`
+
 > Default: `:3000`
 
 Configures healthcheck endpoint address.
 
 ### `WOODPECKER_KEEPALIVE_TIME`
+
 > Default: empty
 
 After a duration of this time of no activity, the agent pings the server to check if the transport is still alive.
 
 ### `WOODPECKER_KEEPALIVE_TIMEOUT`
+
 > Default: `20s`
 
 After pinging for a keepalive check, the agent waits for a duration of this time before closing the connection if no activity.
 
 ### `WOODPECKER_GRPC_SECURE`
+
 > Default: `false`
 
 Configures if the connection to `WOODPECKER_SERVER` should be made using a secure transport.
 
 ### `WOODPECKER_GRPC_VERIFY`
+
 > Default: `true`
 
 Configures if the gRPC server certificate should be verified, only valid when `WOODPECKER_GRPC_SECURE` is `true`.
 
 ### `WOODPECKER_BACKEND`
+
 > Default: `auto-detect`
 
 Configures the backend engine to run pipelines on. Possible values are `auto-detect`, `docker`, `local`, `ssh` or `kubernetes`.

docs/versioned_docs/version-1.0/30-administration/22-backends/10-docker.md

@@ -5,16 +5,19 @@ This is the original backend used with Woodpecker. The docker backend executes e
 ## Configuration
 
 ### `WOODPECKER_BACKEND_DOCKER_NETWORK`
+
 > Default: empty
 
 Set to the name of an existing network which will be attached to all your pipeline containers (steps). Please be careful as this allows the containers of different pipelines to access each other!
 
 ### `WOODPECKER_BACKEND_DOCKER_ENABLE_IPV6`
+
 > Default: `false`
 
 Enable IPv6 for the networks used by pipeline containers (steps). Make sure you configured your docker daemon to support IPv6.
 
 ### `WOODPECKER_BACKEND_DOCKER_VOLUMES`
+
 > Default: empty
 
 List of default volumes separated by comma to be mounted to all pipeline containers (steps). For example to use custom CA

docs/versioned_docs/version-1.0/30-administration/22-backends/20-local.md

@@ -77,15 +77,13 @@ manual clone step.
 The `image` entry is used to specify the shell, such as Bash or Fish, that is
 used to run the commands.
 
-
 ```yaml
 # .woodpecker.yml
 
 steps:
   build:
     image: bash
-    commands:
+    commands: [...]
-      [...]
 ```
 
 ### Using labels to filter tasks
@@ -111,6 +109,5 @@ only run on this agent:
 labels:
   type: exec
 
-steps:
+steps: [...]
-  [...]
 ```

docs/versioned_docs/version-1.0/30-administration/22-backends/30-ssh.md

@@ -16,26 +16,31 @@ The backend will use a random directory in $TMPDIR to store the clone code and e
 ## Configuration
 
 ### `WOODPECKER_BACKEND_SSH_ADDRESS`
+
 > Default: empty
 
 The SSH host to run steps with `ssh` backend.
 
 ### `WOODPECKER_BACKEND_SSH_USER`
+
 > Default: empty
 
 The SSH user to run steps with `ssh` backend.
 
 ### `WOODPECKER_BACKEND_SSH_KEY`
+
 > Default: empty
 
 Path to the private SSH key to run steps with `ssh` backend.
 
 ### `WOODPECKER_BACKEND_SSH_KEY_PASSWORD`
+
 > Default: empty
 
 The password for the private key to run steps with `ssh` backend.
 
 ### `WOODPECKER_BACKEND_SSH_PASSWORD`
+
 > Default empty
 
 The SSH password to run steps with `ssh` backend.

docs/versioned_docs/version-1.0/30-administration/22-backends/40-kubernetes.md

@@ -11,31 +11,37 @@ The kubernetes backend executes each step inside a newly created pod. A PVC is a
 ## Configuration
 
 ### `WOODPECKER_BACKEND_K8S_NAMESPACE`
+
 > Default: `woodpecker`
 
 The namespace to create worker pods in.
 
 ### `WOODPECKER_BACKEND_K8S_VOLUME_SIZE`
+
 > Default: `10G`
 
 The volume size of the pipeline volume.
 
 ### `WOODPECKER_BACKEND_K8S_STORAGE_CLASS`
+
 > Default: empty
 
 The storage class to use for the pipeline volume.
 
 ### `WOODPECKER_BACKEND_K8S_STORAGE_RWX`
+
 > Default: `true`
 
 Determines if `RWX` should be used for the pipeline volume's [access mode](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes). If false, `RWO` is used instead.
 
 ### `WOODPECKER_BACKEND_K8S_POD_LABELS`
+
 > Default: empty
 
 Additional labels to apply to worker pods. Must be a YAML object, e.g. `{"example.com/test-label":"test-value"}`.
 
 ### `WOODPECKER_BACKEND_K8S_POD_ANNOTATIONS`
+
 > Default: empty
 
 Additional annotations to apply to worker pods. Must be a YAML object, e.g. `{"example.com/test-annotation":"test-value"}`.
@@ -59,6 +65,7 @@ By default the pod will use "kubernetes.io/arch" inferred from top-level "platfo
 See the [kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector) for more information on using nodeSelector.
 
 Example pipeline configuration:
+
 ```yaml
 steps:
   build:

docs/versioned_docs/version-1.0/30-administration/40-encryption.md

@@ -22,25 +22,31 @@ enabled encryption method, and `WOODPECKER_ENCRYPTION_DISABLE` set to true.
 After secrets was decrypted server will proceed working in unencrypted mode. You will not need to use "disable encryption"
 variable or encryption keys to start server anymore.
 
-
 ## AES
+
 Simple AES encryption.
 
 ### Configuration
+
 You can manage encryption on server using these environment variables:
+
 - `WOODPECKER_ENCRYPTION_KEY` - encryption key
 - `WOODPECKER_ENCRYPTION_KEY_FILE` - file to read encryption key from
 - `WOODPECKER_ENCRYPTION_DISABLE` - disable encryption flag used to decrypt all data on server
 
 ## TINK
+
 TINK uses AEAD encryption instead of simple AES and supports key rotation.
 
 ### Configuration
+
 You can manage encryption on server using these two environment variables:
+
 - `WOODPECKER_ENCRYPTION_TINK_KEYSET_FILE` - keyset filepath
 - `WOODPECKER_ENCRYPTION_DISABLE` - disable encryption flag used to decrypt all data on server
 
 ### Encryption keys
+
 You will need plaintext AEAD-compatible Google TINK keyset to encrypt your data.
 
 To generate it and then rotate keys if needed, install `tinkey`([installation guide](https://developers.google.com/tink/install-tinkey))
@@ -49,12 +55,15 @@ Keyset contains one or more keys, used to encrypt or decrypt your data, and prim
 to use while encrypting new data.
 
 Keyset generation example:
+
 ```shell
 tinkey create-keyset --key-template AES256_GCM --out-format json --out keyset.json
 ```
 
 ### Key rotation
+
 Use `tinkey` to rotate encryption keys in your existing keyset:
+
 ```shell
 tinkey rotate-keyset --in keyset_v1.json --out keyset_v2.json --key-template AES256_GCM
 ```

docs/versioned_docs/version-1.0/30-administration/70-proxy.md

@@ -108,7 +108,6 @@ ngrok http 8000
 
 Set `WOODPECKER_HOST` (for example in `docker-compose.yml`) to the ngrok URL (usually xxx.ngrok.io) and start the server.
 
-
 ## Traefik
 
 To install the Woodpecker server behind a [Traefik](https://traefik.io/) load balancer, you must expose both the `http` and the `gRPC` ports. Here is a comprehensive example, considering you are running Traefik with docker swarm and want to do TLS termination and automatic redirection from http to https.
@@ -168,7 +167,6 @@ services:
         - traefik.http.middlewares.woodpecker-grpc-redirect.redirectscheme.permanent=true
         - traefik.http.routers.woodpecker-grpc.middlewares=woodpecker-grpc-redirect@docker
 
-
 volumes:
   woodpecker-server-data:
     driver: local

docs/versioned_docs/version-1.0/40-cli.md

@@ -28,7 +28,6 @@ woodpecker-cli [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...]
 
 **--token, -t**="": server auth token
 
-
 # COMMANDS
 
 ## pipeline, build

docs/versioned_docs/version-1.0/91-migrations.md

@@ -54,12 +54,14 @@ No breaking changes
 
 - Dropped support for `DRONE_*` environment variables. The according `WOODPECKER_*` variables must be used instead.
   Additionally some alternative namings have been removed to simplify maintenance:
+
   - `WOODPECKER_AGENT_SECRET` replaces `WOODPECKER_SECRET`, `DRONE_SECRET`, `WOODPECKER_PASSWORD`, `DRONE_PASSWORD` and `DRONE_AGENT_SECRET`.
   - `WOODPECKER_HOST` replaces `DRONE_HOST` and `DRONE_SERVER_HOST`.
   - `WOODPECKER_DATABASE_DRIVER` replaces `DRONE_DATABASE_DRIVER` and `DATABASE_DRIVER`.
   - `WOODPECKER_DATABASE_DATASOURCE` replaces `DRONE_DATABASE_DATASOURCE` and `DATABASE_CONFIG`.
 
 - Dropped support for `DRONE_*` environment variables in pipeline steps. Pipeline meta-data can be accessed with `CI_*` variables.
+
   - `CI_*` prefix replaces `DRONE_*`
   - `CI` value is now `woodpecker`
   - `DRONE=true` has been removed
@@ -89,6 +91,7 @@ No breaking changes
 - Default workspace base path has moved from `/drone` to `/woodpecker`
 
 - Default SQLite database location has changed:
+
   - `/var/lib/drone/drone.sqlite` -> `/var/lib/woodpecker/woodpecker.sqlite`
   - `drone.sqlite` -> `woodpecker.sqlite`
 

docs/versioned_docs/version-1.0/92-development/01-getting-started.md

@@ -27,6 +27,7 @@ Install Golang (>=1.20) as described by [this guide](https://go.dev/doc/install)
 > 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`

docs/versioned_docs/version-1.0/92-development/03-ui.md

@@ -3,6 +3,7 @@
 To develop the UI you need to install [Node.js and pnpm](./01-getting-started.md#install-nodejs--pnpm). 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 `pnpm install`. For production builds the generated UI code is integrated into the Woodpecker server by using [go-embed](https://pkg.go.dev/embed).
 
 Testing UI changes would require us to rebuild the UI after each adjustment to the code by running `pnpm build` and restarting the Woodpecker server. To avoid this you can make use of the dev-proxy integrated into the Woodpecker server. This integrated dev-proxy will forward all none api request to a separate http-server which will only serve the UI files.

docs/versioned_docs/version-1.0/92-development/05-architecture.md

@@ -8,36 +8,36 @@
 
 ### main package hierarchy
 
-| package    | meaning                                                      | imports
+| package            | meaning                                                        | imports                               |
-|------------|--------------------------------------------------------------|----------
+| ------------------ | -------------------------------------------------------------- | ------------------------------------- |
-| `cmd/**`   | parse command-line args & environment to stat server/cli/agent | all other
+| `cmd/**`           | parse command-line args & environment to stat server/cli/agent | all other                             |
-| `agent/**` | code only agent (remote worker) will need                    | `pipeline`, `shared`
+| `agent/**`         | code only agent (remote worker) will need                      | `pipeline`, `shared`                  |
-| `cli/**`   | code only cli tool does need                                 | `pipeline`, `shared`, `woodpecker-go`
+| `cli/**`           | code only cli tool does need                                   | `pipeline`, `shared`, `woodpecker-go` |
-| `server/**`| code only server will need                                   | `pipeline`, `shared`
+| `server/**`        | code only server will need                                     | `pipeline`, `shared`                  |
-| `shared/**`| code shared for all three main tools (go help utils)         | only std and external libs
+| `shared/**`        | code shared for all three main tools (go help utils)           | only std and external libs            |
-| `woodpecker-go/**` | go client for server rest api                        | std
+| `woodpecker-go/**` | go client for server rest api                                  | std                                   |
 
 ### Server
 
-| package              | meaning                                                                             | imports
+| package              | meaning                                                                             | imports                                                                                                                                                                                |
-|----------------------|-------------------------------------------------------------------------------------|----------
+| -------------------- | ----------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `server/api/**`      | handle web requests from `server/router`                                            | `pipeline`, `../badges`, `../ccmenue`, `../logging`, `../model`, `../pubsub`, `../queue`, `../forge`, `../shared`, `../store`, `shared`, (TODO: mv `server/router/middleware/session`)
+| `server/api/**`      | handle web requests from `server/router`                                            | `pipeline`, `../badges`, `../ccmenue`, `../logging`, `../model`, `../pubsub`, `../queue`, `../forge`, `../shared`, `../store`, `shared`, (TODO: mv `server/router/middleware/session`) |
-| `server/badges/**`   | generate svg badges for pipelines                                                   | `../model`
+| `server/badges/**`   | generate svg badges for pipelines                                                   | `../model`                                                                                                                                                                             |
-| `server/ccmenu/**`   | generate xml ccmenu for pipelines                                                   | `../model`
+| `server/ccmenu/**`   | generate xml ccmenu for pipelines                                                   | `../model`                                                                                                                                                                             |
-| `server/grpc/**`     | gRPC server agents can connect to                                                   | `pipeline/rpc/**`, `../logging`, `../model`, `../pubsub`, `../queue`, `../forge`, `../pipeline`, `../store`
+| `server/grpc/**`     | gRPC server agents can connect to                                                   | `pipeline/rpc/**`, `../logging`, `../model`, `../pubsub`, `../queue`, `../forge`, `../pipeline`, `../store`                                                                            |
-| `server/logging/**`  | logging lib for gPRC server to stream logs while running                            | std
+| `server/logging/**`  | logging lib for gPRC server to stream logs while running                            | std                                                                                                                                                                                    |
-| `server/model/**`    | structs for store (db) and api (json)                                               | std
+| `server/model/**`    | structs for store (db) and api (json)                                               | std                                                                                                                                                                                    |
-| `server/plugins/**`  | plugins for server                                                                  | `../model`, `../forge`
+| `server/plugins/**`  | plugins for server                                                                  | `../model`, `../forge`                                                                                                                                                                 |
-| `server/pipeline/**` | orchestrate pipelines                                                               | `pipeline`, `../model`, `../pubsub`, `../queue`, `../forge`, `../store`, `../plugins`
+| `server/pipeline/**` | orchestrate pipelines                                                               | `pipeline`, `../model`, `../pubsub`, `../queue`, `../forge`, `../store`, `../plugins`                                                                                                  |
-| `server/pubsub/**`   | pubsub lib for server to push changes to the WebUI                                  | std
+| `server/pubsub/**`   | pubsub lib for server to push changes to the WebUI                                  | std                                                                                                                                                                                    |
-| `server/queue/**`    | queue lib for server where agents pull new pipelines from via gRPC                  | `server/model`
+| `server/queue/**`    | queue lib for server where agents pull new pipelines from via gRPC                  | `server/model`                                                                                                                                                                         |
-| `server/forge/**`    | forge lib for server to connect and handle forge specific stuff                     | `shared`, `server/model`
+| `server/forge/**`    | forge lib for server to connect and handle forge specific stuff                     | `shared`, `server/model`                                                                                                                                                               |
-| `server/router/**`   | handle requests to REST API (and all middleware) and serve UI and WebUI config      | `shared`, `../api`, `../model`, `../forge`, `../store`, `../web`
+| `server/router/**`   | handle requests to REST API (and all middleware) and serve UI and WebUI config      | `shared`, `../api`, `../model`, `../forge`, `../store`, `../web`                                                                                                                       |
-| `server/store/**`    | handle database                                                                     | `server/model`
+| `server/store/**`    | handle database                                                                     | `server/model`                                                                                                                                                                         |
 | `server/shared/**`   | TODO: move and split [#974](https://github.com/woodpecker-ci/woodpecker/issues/974) |
 | `server/web/**`      | server SPA                                                                          |
 
-* `../` = `server/`
+- `../` = `server/`
 
 ### Agent
 

docs/versioned_docs/version-1.0/92-development/08-swagger.md

@@ -39,12 +39,13 @@ type User struct {
 ```
 
 These guidelines aim to have consistent wording in the swagger doc:
-* first word after `@Summary` and `@Summary` are always uppercase
+
-* `@Summary` has no . (dot) at the end of the line
+- first word after `@Summary` and `@Summary` are always uppercase
-* model structs shall use custom short names, to ease life for API consumers, using `@name`
+- `@Summary` has no . (dot) at the end of the line
-* `@Success` object or array declarations shall be short, this means the actual `model.User` struct must have a `@name` annotation, so that the model can be renderend in Swagger
+- model structs shall use custom short names, to ease life for API consumers, using `@name`
-* when pagination is used, `@Parame page` and `@Parame perPage` must be added manually
+- `@Success` object or array declarations shall be short, this means the actual `model.User` struct must have a `@name` annotation, so that the model can be renderend in Swagger
-* `@Param Authorization` is almost always present, there are just a few un-protected endpoints
+- when pagination is used, `@Parame page` and `@Parame perPage` must be added manually
+- `@Param Authorization` is almost always present, there are just a few un-protected endpoints
 
 There are many examples in the server/api package, which you can use a blueprint.
 More enhanced information you can find here https://github.com/swaggo/swag/blob/master/README.md#declarative-comments-format

docs/versioned_docs/version-2.7/92-development/05-architecture.md

@@ -20,7 +20,7 @@
 ### Server
 
 | package              | meaning                                                                             | imports                                                                                                                                                                               |
-| -------------------- | ----------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| -------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `server/api/**`      | handle web requests from `server/router`                                            | `pipeline`, `../badges`, `../ccmenu`, `../logging`, `../model`, `../pubsub`, `../queue`, `../forge`, `../shared`, `../store`, `shared`, (TODO: mv `server/router/middleware/session`) |
 | `server/badges/**`   | generate svg badges for pipelines                                                   | `../model`                                                                                                                                                                            |
 | `server/ccmenu/**`   | generate xml ccmenu for pipelines                                                   | `../model`                                                                                                                                                                            |

docs/versioned_docs/version-2.8/20-usage/40-secrets.md

@@ -15,7 +15,7 @@ Woodpecker provides three different levels to add secrets to your pipeline. The
 
 :::warning
 The use of secrets is deprecated as of version 2.8 and planned to be removed with version 3.
-Instead, you can use the *secrets in settings and environment* approach outlined below.
+Instead, you can use the _secrets in settings and environment_ approach outlined below.
 You can already migrate to this strategy with version 2.8.
 :::
 

docs/versioned_docs/version-2.8/20-usage/90-advanced-usage.md

@@ -168,6 +168,7 @@ services:
      ports:
        - 2376
 ```
+
 In the step that needs access to the daemon we need to:
 
 1. Set the `DOCKER_*` environment variables shown below, setting up the connection with the daemon. These are standardized environment variables that should work with the docker client used by your framework of choice (e.g. [TestContainers](https://testcontainers.com/), [Spring Boot Docker Compose](https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-docker-compose) or similar).