Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add jsonschema #4487

Merged
merged 6 commits into from
Mar 11, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/post-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,9 @@ jobs:
- name: Update reference files
run: cp .golangci.next.reference.yml .golangci.reference.yml

- name: Update JSON schema files
run: cp .schema/next.jsonschema.json .schema/jsonschema.json
ldez marked this conversation as resolved.
Show resolved Hide resolved

- name: Update information
run: make website_dump_info

Expand Down
76 changes: 76 additions & 0 deletions .schema/gcl-custom.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$ref": "#/$defs/Configuration",
"$defs": {
"Configuration": {
"properties": {
"version": {
"type": "string",
"description": "golangci-lint version."
},
"name": {
"type": "string",
"description": "Name of the binary."
},
"destination": {
"type": "string",
"description": "Destination is the path to a directory to store the binary."
},
"plugins": {
"items": {
"$ref": "#/$defs/Plugin"
},
"type": "array",
"description": "Plugins information."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"version"
],
"description": "Configuration represents the configuration file."
},
"Plugin": {
"oneOf": [
{
"required": [
"version"
],
"title": "version"
},
{
"required": [
"path"
],
"title": "path"
}
],
"properties": {
"module": {
"type": "string",
"description": "Module name."
},
"import": {
"type": "string",
"description": "Import to use."
},
"version": {
"type": "string",
"description": "Version of the module.\nOnly for module available through a Go proxy."
},
"path": {
"type": "string",
"description": "Path to the local module.\nOnly for local module."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"module"
],
"description": "Plugin represents information about a plugin."
}
},
"description": "mygcl configuration definition file"
}
Loading
Loading