search

woodpecker-ci / woodpecker

Woodpecker is a simple yet powerful CI/CD engine with great extensibility.
https://woodpecker-ci.org
Apache License 2.0
3.95k stars 351 forks source link

update links in jsonschema to current v1.0.0 docs #2063

Closed 6543 closed 5 months ago

6543 commented 1 year ago

we have a lot of wrong links in the jsonschema linking to old v0.15.0 paths

6543 commented 1 year ago

it would also be nice if the 'current' version also has a prefix, this will make links not break that easily

now

desired

https://github.com/woodpecker-ci/woodpecker/blob/e01c478066adb0d289cee5d79fb3a9260b48b9b5/docs/docusaurus.config.js#L215-L227

6543 commented 1 year ago

cc @anbraten :point_up: ?

lonix1 commented 12 months ago

From my dupe issue:

Since https://github.com/woodpecker-ci/woodpecker/issues/1948 was fixed, the json schema for .woodpecker.yml is out of date.

Consider this code: it ensures the logs show "clone" instead of "git" (as it was before the fix):

clone:
  clone:           # can be any word: "clone", "git" or whatever
    image: woodpeckerci/plugin-git:2.0.3

steps:
    # ...

But the schema only allows "git". If I use "clone" then I get an error in vscode: Property clone is not allowed.

I couldn't submit a PR because I'm unsure how to fix it - I can't just change "git" to "clone" as both are valid, as well as any other word.

anbraten commented 11 months ago

it would also be nice if the 'current' version also has a prefix, this will make links not break that easily

Using old links (with a prefix) however will send users to outdated docs (as most users will / should use the newest version anyways) this would introduce more new issues than actually solving.

gedw99 commented 11 months ago

Mhh gen json Schema of golang types ?

Saw a package for it last week if there is any interest

6543 commented 11 months ago

@gedw99 if you know the link again just comment it here :)