mirrors/woodpecker
1
0
Fork 0
mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2025-01-03 14:18:42 +00:00
Code Issues Projects Releases Wiki Activity

Fix schema links (#3369)

Browse source 
Closes https://github.com/woodpecker-ci/woodpecker/issues/2063
This commit is contained in:
qwerty287 2024-02-11 09:53:02 +01:00 committed by GitHub
parent f369d2c543
commit 894ab51215
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 46 additions and 46 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

92
pipeline/frontend/yaml/linter/schema/schema.json
View file

@ -2,7 +2,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://woodpecker-ci.org/schema/woodpecker.json",
"description": "Schema of a Woodpecker pipeline file. Read more: https://woodpecker-ci.org/docs/usage/pipeline-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"],
"additionalProperties": false, "additionalProperties": false,
@ -12,7 +12,7 @@
"format": "uri" "format": "uri"
}, },
"variables": { "variables": {
"description": "Use yaml aliases to define variables. Read more: https://woodpecker-ci.org/docs/usage/advanced-yaml-syntax" "description": "Use yaml aliases to define variables. Read more: https://woodpecker-ci.org/docs/usage/advanced-usage"
}, },
"clone": { "clone": {
"$ref": "#/definitions/clone" "$ref": "#/definitions/clone"
@ -69,7 +69,7 @@
}, },
"definitions": { "definitions": {
"clone": { "clone": {
"description": "Configures the clone step. Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#clone", "description": "Configures the clone step. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#clone",
"oneOf": [ "oneOf": [
{ {
"type": "object", "type": "object",
@ -129,7 +129,7 @@
} }
}, },
"branches": { "branches": {
"description": "Only include commits based on their target branch. Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#branches", "description": "deprecated, use when.branch",
"oneOf": [ "oneOf": [
{ {
"type": "array", "type": "array",
@ -178,7 +178,7 @@
] ]
}, },
"step_list": { "step_list": {
"description": "The steps section defines a list of steps which will be executed serially, in the order in which they are defined. Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax", "description": "The steps section defines a list of steps which will be executed serially, in the order in which they are defined. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#steps",
"oneOf": [ "oneOf": [
{ {
"type": "object", "type": "object",
@ -197,7 +197,7 @@
] ]
}, },
"pipeline_when": { "pipeline_when": {
"description": "Whole pipelines can be skipped based on conditions. Read more: https://woodpecker-ci.org/docs/next/usage/pipeline-syntax#when---global-pipeline-conditions", "description": "Whole pipelines can be skipped based on conditions. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#when---global-workflow-conditions",
"oneOf": [ "oneOf": [
{ {
"type": "array", "type": "array",
@ -216,15 +216,15 @@
"additionalProperties": false, "additionalProperties": false,
"properties": { "properties": {
"repo": { "repo": {
"description": "Execute a step only on a specific repository. Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#repo", "description": "Execute a step only on a specific repository. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#repo",
"$ref": "#/definitions/constraint_list" "$ref": "#/definitions/constraint_list"
}, },
"branch": { "branch": {
"description": "Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#branch", "description": "Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#branch",
"$ref": "#/definitions/constraint_list" "$ref": "#/definitions/constraint_list"
}, },
"event": { "event": {
"description": "Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#event", "description": "Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#event",
"default": [], "default": [],
"oneOf": [ "oneOf": [
{ {
@ -240,27 +240,27 @@
] ]
}, },
"ref": { "ref": {
"description": "Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#ref", "description": "Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#ref",
"type": "string" "type": "string"
}, },
"cron": { "cron": {
"description": "filter cron by title. Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#cron", "description": "filter cron by title. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#cron",
"$ref": "#/definitions/constraint_list" "$ref": "#/definitions/constraint_list"
}, },
"platform": { "platform": {
"description": "Execute a step only on a specific platform. Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#platform", "description": "Execute a step only on a specific platform. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#platform",
"$ref": "#/definitions/constraint_list" "$ref": "#/definitions/constraint_list"
}, },
"environment": { "environment": {
"description": "Execute a step only for a specific environment. Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#environment", "description": "Execute a step only for a specific environment. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#environment",
"$ref": "#/definitions/constraint_list" "$ref": "#/definitions/constraint_list"
}, },
"instance": { "instance": {
"description": "Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#instance", "description": "Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#instance",
"$ref": "#/definitions/constraint_list" "$ref": "#/definitions/constraint_list"
}, },
"path": { "path": {
"description": "Execute a step only on commit with certain files added/removed/modified. Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#path", "description": "Execute a step only on commit with certain files added/removed/modified. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#path",
"oneOf": [ "oneOf": [
{ {
"type": "string" "type": "string"
@ -295,13 +295,13 @@
] ]
}, },
"evaluate": { "evaluate": {
"description": "Execute a step only if the expression evaluates to true. Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#evaluate", "description": "Execute a step only if the expression evaluates to true. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#evaluate",
"type": "string" "type": "string"
} }
} }
}, },
"step": { "step": {
"description": "Every step of your pipeline executes arbitrary commands inside a specified docker container. Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#steps", "description": "Every step of your pipeline executes arbitrary commands inside a specified docker container. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#steps",
"type": "object", "type": "object",
"additionalProperties": false, "additionalProperties": false,
"required": ["image"], "required": ["image"],
@ -341,7 +341,7 @@
"$ref": "#/definitions/step_volumes" "$ref": "#/definitions/step_volumes"
}, },
"group": { "group": {
"description": "Execute multiple steps with the same group key in parallel. Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#step-group---parallel-execution", "description": "deprecated, use depends_on",
"type": "string" "type": "string"
}, },
"depends_on": { "depends_on": {
@ -364,7 +364,7 @@
"type": "boolean" "type": "boolean"
}, },
"failure": { "failure": {
"description": "How to handle the failure of this step. Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#failure", "description": "How to handle the failure of this step. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#failure",
"type": "string", "type": "string",
"enum": ["fail", "ignore"], "enum": ["fail", "ignore"],
"default": "fail" "default": "fail"
@ -375,7 +375,7 @@
} }
}, },
"step_when": { "step_when": {
"description": "Steps can be skipped based on conditions. Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#when---conditional-execution", "description": "Steps can be skipped based on conditions. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#when---conditional-execution",
"oneOf": [ "oneOf": [
{ {
"type": "array", "type": "array",
@ -394,27 +394,27 @@
"additionalProperties": false, "additionalProperties": false,
"properties": { "properties": {
"repo": { "repo": {
"description": "Execute a step only on a specific repository. Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#repo", "description": "Execute a step only on a specific repository. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#repo",
"$ref": "#/definitions/constraint_list" "$ref": "#/definitions/constraint_list"
}, },
"branch": { "branch": {
"description": "Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#branch", "description": "Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#branch",
"$ref": "#/definitions/constraint_list" "$ref": "#/definitions/constraint_list"
}, },
"event": { "event": {
"description": "Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#event", "description": "Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#event",
"$ref": "#/definitions/event_constraint_list" "$ref": "#/definitions/event_constraint_list"
}, },
"ref": { "ref": {
"description": "Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#ref", "description": "Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#ref",
"type": "string" "type": "string"
}, },
"cron": { "cron": {
"description": "filter cron by title. Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#cron", "description": "filter cron by title. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#cron",
"$ref": "#/definitions/constraint_list" "$ref": "#/definitions/constraint_list"
}, },
"status": { "status": {
"description": "Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#status", "description": "Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#status",
"oneOf": [ "oneOf": [
{ {
"type": "array", "type": "array",
@ -431,26 +431,26 @@
] ]
}, },
"platform": { "platform": {
"description": "Execute a step only on a specific platform. Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#platform", "description": "Execute a step only on a specific platform. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#platform",
"$ref": "#/definitions/constraint_list" "$ref": "#/definitions/constraint_list"
}, },
"environment": { "environment": {
"description": "Execute a step only for a specific environment. Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#environment", "description": "Execute a step only for a specific environment. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#environment",
"$ref": "#/definitions/constraint_list" "$ref": "#/definitions/constraint_list"
}, },
"matrix": { "matrix": {
"description": "Read more: https://woodpecker-ci.org/docs/usage/matrix-pipelines", "description": "Read more: https://woodpecker-ci.org/docs/usage/matrix-workflows",
"type": "object", "type": "object",
"additionalProperties": { "additionalProperties": {
"type": ["boolean", "string", "number"] "type": ["boolean", "string", "number"]
} }
}, },
"instance": { "instance": {
"description": "Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#instance", "description": "Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#instance",
"$ref": "#/definitions/constraint_list" "$ref": "#/definitions/constraint_list"
}, },
"path": { "path": {
"description": "Execute a step only on commit with certain files added/removed/modified. Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#path", "description": "Execute a step only on commit with certain files added/removed/modified. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#path",
"oneOf": [ "oneOf": [
{ {
"type": "string" "type": "string"
@ -485,7 +485,7 @@
] ]
}, },
"evaluate": { "evaluate": {
"description": "Execute a step only if the expression evaluates to true. Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#evaluate", "description": "Execute a step only if the expression evaluates to true. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#evaluate",
"type": "string" "type": "string"
} }
} }
@ -590,20 +590,20 @@
] ]
}, },
"step_image": { "step_image": {
"description": "Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#image", "description": "Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#image",
"type": "string" "type": "string"
}, },
"step_privileged": { "step_privileged": {
"description": "Run the step in privileged mode. Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#privileged", "description": "Run the step in privileged mode. Read more: https://woodpecker-ci.org/docs/next/usage/workflow-syntax#privileged-mode",
"type": "boolean", "type": "boolean",
"default": false "default": false
}, },
"step_pull": { "step_pull": {
"description": "Always pull the latest image on pipeline execution Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#image", "description": "Always pull the latest image on pipeline execution Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#image",
"type": "boolean" "type": "boolean"
}, },
"step_commands": { "step_commands": {
"description": "Commands of every pipeline step are executed serially as if you would enter them into your local shell. Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#commands", "description": "Commands of every pipeline step are executed serially as if you would enter them into your local shell. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#commands",
"oneOf": [ "oneOf": [
{ {
"type": "array", "type": "array",
@ -660,7 +660,7 @@
"minLength": 1 "minLength": 1
}, },
"step_settings": { "step_settings": {
"description": "Change the settings of your plugin. Read more: https://woodpecker-ci.org/docs/usage/plugins/plugins", "description": "Change the settings of your plugin. Read more: https://woodpecker-ci.org/docs/usage/plugins/overview",
"type": "object", "type": "object",
"additionalProperties": { "additionalProperties": {
"type": ["boolean", "string", "number", "array", "object"] "type": ["boolean", "string", "number", "array", "object"]
@ -675,7 +675,7 @@
"minLength": 1 "minLength": 1
}, },
"step_directory": { "step_directory": {
"description": "Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#directory", "description": "Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#directory",
"type": "string" "type": "string"
}, },
"step_backend_options": { "step_backend_options": {
@ -700,7 +700,7 @@
} }
}, },
"step_backend_kubernetes_resources": { "step_backend_kubernetes_resources": {
"description": "Resources for the kubernetes backend. Read more: https://woodpecker-ci.org/docs/administration/backends/kubernetes", "description": "Resources for the kubernetes backend. Read more: https://woodpecker-ci.org/docs/administration/backends/kubernetes#job-specific-configuration",
"type": "object", "type": "object",
"properties": { "properties": {
"requests": { "requests": {
@ -712,7 +712,7 @@
} }
}, },
"step_backend_kubernetes_security_context": { "step_backend_kubernetes_security_context": {
"description": "Pods / containers security context. Read more: https://woodpecker-ci.org/docs/administration/backends/kubernetes", "description": "Pods / containers security context. Read more: https://woodpecker-ci.org/docs/administration/backends/kubernetes#securitycontext",
"type": "object", "type": "object",
"properties": { "properties": {
"privileged": { "privileged": {
@ -739,7 +739,7 @@
} }
}, },
"step_backend_kubernetes_secprofile": { "step_backend_kubernetes_secprofile": {
"description": "Pods / containers security profile. Read more: https://woodpecker-ci.org/docs/administration/backends/kubernetes", "description": "Pods / containers security profile. Read more: https://woodpecker-ci.org/docs/administration/backends/kubernetes#job-specific-configuration",
"type": "object", "type": "object",
"properties": { "properties": {
"type": { "type": {
@ -758,7 +758,7 @@
} }
}, },
"step_backend_kubernetes_service_account": { "step_backend_kubernetes_service_account": {
"description": "serviceAccountName to be use by job. Read more: https://woodpecker-ci.org/docs/administration/backends/kubernetes", "description": "serviceAccountName to be use by job. Read more: https://woodpecker-ci.org/docs/administration/backends/kubernetes#serviceaccountname",
"type": "object", "type": "object",
"properties": { "properties": {
"requests": { "requests": {
@ -854,12 +854,12 @@
} }
}, },
"workspace": { "workspace": {
"description": "Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#workspace", "description": "Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#workspace",
"type": "object", "type": "object",
"additionalProperties": true "additionalProperties": true
}, },
"matrix": { "matrix": {
"description": "Execute pipeline for each matrix combination. Read more: https://woodpecker-ci.org/docs/usage/matrix-pipelines", "description": "Execute pipeline for each matrix combination. Read more: https://woodpecker-ci.org/docs/usage/matrix-workflows",
"type": "object", "type": "object",
"properties": { "properties": {
"include": { "include": {
@ -879,12 +879,12 @@
} }
}, },
"platform": { "platform": {
"description": "Configures the platform the pipeline will be executed on. Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#platform", "description": "deprecated, use labels.platform",
"type": "string", "type": "string",
"additionalProperties": false "additionalProperties": false
}, },
"labels": { "labels": {
"description": "Configures the labels used for the agent selection. Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#clone", "description": "Configures the labels used for the agent selection. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#labels",
"type": "object", "type": "object",
"additionalProperties": { "additionalProperties": {
"type": ["boolean", "string", "number"] "type": ["boolean", "string", "number"]