Skip to content

Commit

Permalink
doc: Added doc about server compatibility
Browse files Browse the repository at this point in the history
  • Loading branch information
JulesFaucherre committed May 10, 2023
1 parent b7d2142 commit 02a87b9
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,3 +178,7 @@ 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

Some features are accessible on Server only starting specific Server versions:
- validate orb using private orb with the options `--org-slug <org-slug>` of `circleci orb validate` is only available from **Server 4.2.0**
2 changes: 1 addition & 1 deletion api/api.go
Original file line number Diff line number Diff line change
Expand Up @@ -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!) {
Expand Down

0 comments on commit 02a87b9

Please sign in to comment.