From 5d3a503f98fa0e65c406ed372161c4beab7b0848 Mon Sep 17 00:00:00 2001 From: qwerty287 <80460567+qwerty287@users.noreply.github.com> Date: Mon, 12 Feb 2024 15:00:33 +0100 Subject: [PATCH] Add link checking (#3371) Closes https://github.com/woodpecker-ci/woodpecker/issues/3332 --- .woodpecker/static.yaml | 34 +++++++++++++++++++ .woodpecker/test.yaml | 23 ------------- .../00-deployment/10-docker-compose.md | 2 +- .../30-administration/10-server-config.md | 8 ++--- .../11-forges/10-overview.md | 18 +++++----- docs/docs/92-development/08-swagger.md | 2 +- .../frontend/yaml/linter/schema/schema.json | 2 +- 7 files changed, 50 insertions(+), 39 deletions(-) create mode 100644 .woodpecker/static.yaml diff --git a/.woodpecker/static.yaml b/.woodpecker/static.yaml new file mode 100644 index 000000000..7baea6d59 --- /dev/null +++ b/.woodpecker/static.yaml @@ -0,0 +1,34 @@ +when: + - event: pull_request + - event: push + branch: renovate/* + +steps: + - name: lint-editorconfig + image: docker.io/mstruebing/editorconfig-checker:2.7.2 + depends_on: [] + when: + - event: pull_request + - event: push + branch: renovate/* + + - name: spellcheck + image: docker.io/node:21-alpine + depends_on: [] + commands: + - corepack enable + - pnpx cspell lint --no-progress --gitignore '{**,.*}/{*,.*}' + + - name: prettier + image: docker.io/woodpeckerci/plugin-prettier:0.1.0 + depends_on: [] + settings: + version: 3.2.4 + + - name: links + image: lycheeverse/lychee:0.14.0 + depends_on: [] + commands: + - lychee pipeline/frontend/yaml/linter/schema/schema.json + - lychee --exclude localhost docs/docs/ + - lychee --exclude localhost docs/src/pages/ diff --git a/.woodpecker/test.yaml b/.woodpecker/test.yaml index 1ca3b699c..fa9337698 100644 --- a/.woodpecker/test.yaml +++ b/.woodpecker/test.yaml @@ -68,13 +68,6 @@ steps: - '[ -n "$DIFF" ] && { echo "swagger not up to date, exec `make generate-swagger` and commit"; exit 1; } || true' when: *when - lint-editorconfig: - image: docker.io/mstruebing/editorconfig-checker:2.7.2 - when: - - event: pull_request - - event: push - branch: renovate/* - lint-license-header: image: *golang_image commands: @@ -82,22 +75,6 @@ steps: - 'addlicense -check -ignore "vendor/**" **/*.go' when: *when - prettier: - image: docker.io/woodpeckerci/plugin-prettier:0.1.0 - settings: - version: 3.2.4 - when: - - event: pull_request - - event: push - branch: renovate/* - - spellcheck: - image: docker.io/node:21-alpine - commands: - - corepack enable - - pnpx cspell lint --no-progress --gitignore '{**,.*}/{*,.*}' - when: *when - test: depends_on: - vendor diff --git a/docs/docs/30-administration/00-deployment/10-docker-compose.md b/docs/docs/30-administration/00-deployment/10-docker-compose.md index 2212f7b2f..a9c2bb6ab 100644 --- a/docs/docs/30-administration/00-deployment/10-docker-compose.md +++ b/docs/docs/30-administration/00-deployment/10-docker-compose.md @@ -67,7 +67,7 @@ They can be configured with `*_ADDR` variables: + - WOODPECKER_SERVER_ADDR=${WOODPECKER_HTTP_ADDR} ``` -Reverse proxying can also be [configured for gRPC](../proxy#caddy). If the agents are connecting over the internet, it should also be SSL encrypted. The agent then needs to be configured to be secure: +Reverse proxying can also be [configured for gRPC](../70-proxy.md#caddy). If the agents are connecting over the internet, it should also be SSL encrypted. The agent then needs to be configured to be secure: ```diff title="docker-compose.yaml" version: '3' diff --git a/docs/docs/30-administration/10-server-config.md b/docs/docs/30-administration/10-server-config.md index 9c6e8372a..7d38c75a2 100644 --- a/docs/docs/30-administration/10-server-config.md +++ b/docs/docs/30-administration/10-server-config.md @@ -571,16 +571,16 @@ Disable version check in admin web UI. ### `WOODPECKER_GITHUB_...` -See [GitHub configuration](forges/github/#configuration) +See [GitHub configuration](./11-forges/20-github.md#configuration) ### `WOODPECKER_GITEA_...` -See [Gitea configuration](forges/gitea/#configuration) +See [Gitea configuration](./11-forges/30-gitea.md#configuration) ### `WOODPECKER_BITBUCKET_...` -See [Bitbucket configuration](forges/bitbucket/#configuration) +See [Bitbucket configuration](./11-forges/50-bitbucket.md#configuration) ### `WOODPECKER_GITLAB_...` -See [Gitlab configuration](forges/gitlab/#configuration) +See [Gitlab configuration](./11-forges/40-gitlab.md#configuration) diff --git a/docs/docs/30-administration/11-forges/10-overview.md b/docs/docs/30-administration/11-forges/10-overview.md index bacce1635..6a0122e61 100644 --- a/docs/docs/30-administration/11-forges/10-overview.md +++ b/docs/docs/30-administration/11-forges/10-overview.md @@ -2,12 +2,12 @@ ## 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: | -| Event: Release | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x: | -| Event: Deploy | :white_check_mark: | :x: | :x: | :x: | -| [Multiple workflows](../../20-usage/25-workflows.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| [when.path filter](../../20-usage/20-workflow-syntax.md#path) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x: | +| Feature | [GitHub](20-github.md) | [Gitea / Forgejo](30-gitea.md) | [Gitlab](40-gitlab.md) | [Bitbucket](50-bitbucket.md) | +| ------------------------------------------------------------- | :--------------------: | :----------------------------: | :--------------------: | :--------------------------: | +| 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: | +| Event: Release | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x: | +| Event: Deploy | :white_check_mark: | :x: | :x: | :x: | +| [Multiple workflows](../../20-usage/25-workflows.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| [when.path filter](../../20-usage/20-workflow-syntax.md#path) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x: | diff --git a/docs/docs/92-development/08-swagger.md b/docs/docs/92-development/08-swagger.md index 92505a8fc..9a3775c41 100644 --- a/docs/docs/92-development/08-swagger.md +++ b/docs/docs/92-development/08-swagger.md @@ -46,7 +46,7 @@ These guidelines aim to have consistent wording in the swagger doc: - `@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 +More enhanced information you can find here ### Manual code generation diff --git a/pipeline/frontend/yaml/linter/schema/schema.json b/pipeline/frontend/yaml/linter/schema/schema.json index a6315710b..41d69de62 100644 --- a/pipeline/frontend/yaml/linter/schema/schema.json +++ b/pipeline/frontend/yaml/linter/schema/schema.json @@ -1,7 +1,7 @@ { "title": "Woodpecker CI configuration file", "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "https://woodpecker-ci.org/schema/woodpecker.json", + "$id": "https://raw.githubusercontent.com/woodpecker-ci/woodpecker/main/pipeline/frontend/yaml/linter/schema/schema.json", "description": "Schema of a Woodpecker pipeline file. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax", "type": "object", "required": ["steps"],