Add link checking (#3371)

Closes https://github.com/woodpecker-ci/woodpecker/issues/3332
This commit is contained in:
qwerty287 2024-02-12 15:00:33 +01:00 committed by GitHub
parent 82e1ce937c
commit 5d3a503f98
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 50 additions and 39 deletions

34
.woodpecker/static.yaml Normal file
View file

@ -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/

View file

@ -68,13 +68,6 @@ steps:
- '[ -n "$DIFF" ] && { echo "swagger not up to date, exec `make generate-swagger` and commit"; exit 1; } || true' - '[ -n "$DIFF" ] && { echo "swagger not up to date, exec `make generate-swagger` and commit"; exit 1; } || true'
when: *when when: *when
lint-editorconfig:
image: docker.io/mstruebing/editorconfig-checker:2.7.2
when:
- event: pull_request
- event: push
branch: renovate/*
lint-license-header: lint-license-header:
image: *golang_image image: *golang_image
commands: commands:
@ -82,22 +75,6 @@ steps:
- 'addlicense -check -ignore "vendor/**" **/*.go' - 'addlicense -check -ignore "vendor/**" **/*.go'
when: *when 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: test:
depends_on: depends_on:
- vendor - vendor

View file

@ -67,7 +67,7 @@ They can be configured with `*_ADDR` variables:
+ - WOODPECKER_SERVER_ADDR=${WOODPECKER_HTTP_ADDR} + - 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" ```diff title="docker-compose.yaml"
version: '3' version: '3'

View file

@ -571,16 +571,16 @@ Disable version check in admin web UI.
### `WOODPECKER_GITHUB_...` ### `WOODPECKER_GITHUB_...`
See [GitHub configuration](forges/github/#configuration) See [GitHub configuration](./11-forges/20-github.md#configuration)
### `WOODPECKER_GITEA_...` ### `WOODPECKER_GITEA_...`
See [Gitea configuration](forges/gitea/#configuration) See [Gitea configuration](./11-forges/30-gitea.md#configuration)
### `WOODPECKER_BITBUCKET_...` ### `WOODPECKER_BITBUCKET_...`
See [Bitbucket configuration](forges/bitbucket/#configuration) See [Bitbucket configuration](./11-forges/50-bitbucket.md#configuration)
### `WOODPECKER_GITLAB_...` ### `WOODPECKER_GITLAB_...`
See [Gitlab configuration](forges/gitlab/#configuration) See [Gitlab configuration](./11-forges/40-gitlab.md#configuration)

View file

@ -2,12 +2,12 @@
## Supported features ## Supported features
| Feature | [GitHub](github/) | [Gitea / Forgejo](gitea/) | [Gitlab](gitlab/) | [Bitbucket](bitbucket/) | | 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: 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: 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: 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: Release | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x: |
| Event: Deploy | :white_check_mark: | :x: | :x: | :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: | | [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: | | [when.path filter](../../20-usage/20-workflow-syntax.md#path) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x: |

View file

@ -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 - `@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. 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/main/README.md#declarative-comments-format> More enhanced information you can find here <https://github.com/swaggo/swag/blob/master/README.md#declarative-comments-format>
### Manual code generation ### Manual code generation

View file

@ -1,7 +1,7 @@
{ {
"title": "Woodpecker CI configuration file", "title": "Woodpecker CI configuration file",
"$schema": "http://json-schema.org/draft-07/schema#", "$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", "description": "Schema of a Woodpecker pipeline file. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax",
"type": "object", "type": "object",
"required": ["steps"], "required": ["steps"],