From 894b058a828241bb6784d36a6dc25bdafa9c2f8b Mon Sep 17 00:00:00 2001 From: JulesFaucherre Date: Wed, 10 May 2023 16:04:41 +0200 Subject: [PATCH] doc: Added doc about server compatibility --- README.md | 5 +++++ api/api.go | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 18beace6c..f0b57c504 100644 --- a/README.md +++ b/README.md @@ -178,3 +178,8 @@ Development instructions for the CircleCI CLI can be found in [HACKING.md](HACKI Please see the [documentation](https://circleci-public.github.io/circleci-cli) or `circleci help` for more. +## Server compatibility + +There are some difference of behavior depending on the version you use: + - config validation will use the GraphQL API until **Server v4.0.5, v4.1.3, v4.2.0**. The above versions will use the new route `compile-config-with-defaults` + - `circleci orb validate` will only allow you to validate orb using other orbs using the option `--org-slug` from version **Server v4.2.0** \ No newline at end of file diff --git a/api/api.go b/api/api.go index 3d283930c..c34d606af 100644 --- a/api/api.go +++ b/api/api.go @@ -564,7 +564,7 @@ func makeOrbRequest(cl *graphql.Client, configContent string, ownerId string) (* } if ownerId != "" { - return nil, errors.Errorf("Your version of server does not support validating orbs that refer private orbs") + return nil, errors.Errorf("Your version of Server does not support validating orbs that refer private orbs. Please refer to the README to see compatibility: https://github.com/CircleCI-Public/circleci-cli#server-compatibility") } query := ` query ValidateOrb ($config: String!) {