Skip to content

Commit 687618b

Browse files
author
Virag Sharma
committed
add the version-compatibility-check.md document
1 parent 790b5d9 commit 687618b

1 file changed

Lines changed: 56 additions & 0 deletions

File tree

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Version compatibility check
2+
3+
When you run `grz-cli`, it automatically checks whether your installed version is compatible with the current requirements. If your version is too old, too new, or simply behind the recommended release, you will be informed before any submission processing tasks begin.
4+
5+
## What happens when you run grz-cli
6+
7+
On startup, the tool fetches a version policy from a central location and compares it against your installed version. Depending on the result, one of four things will happen:
8+
9+
| Situation | What you'll see | Does execution continue? |
10+
|---|---|---|
11+
| Your version is too old | Error message | No |
12+
| Your version works but is behind the recommendation | Warning message | Yes |
13+
| Your version is newer than the supported maximum | Error message | No |
14+
| Your version is within the supported range | Confirmation message | Yes |
15+
16+
If no policy is currently in effect, the check is silently skipped and execution continues normally.
17+
18+
## What the messages mean
19+
20+
**"Your grz-cli version is not supported"**
21+
22+
Your installed version is below the minimum required. You must upgrade before you can continue.
23+
24+
```
25+
Example message: Your grz-cli version (1.2.0) is not supported. Minimum required version is 1.5.0.
26+
```
27+
28+
**"Upgrading is strongly recommended"**
29+
30+
Your version meets the minimum requirement but is behind the recommended release. You can continue, but upgrading is advised.
31+
32+
```
33+
Example message: You are using grz-cli 1.5.0, but the recommended version is 1.7.0.
34+
Upgrading is strongly recommended.
35+
```
36+
37+
**"grz-cli is within the supported and tested range"**
38+
39+
Your version is fully compatible. No action is needed.
40+
41+
```
42+
Example message: grz-cli 1.7.0 is within the supported and tested range.
43+
```
44+
45+
**"Version is newer than the maximum supported version"**
46+
47+
Your version is ahead of what has been tested and approved. You must downgrade before you can continue.
48+
49+
```
50+
Example message: grz-cli version 2.1.0 is newer than the maximum supported version (2.0.0).
51+
```
52+
53+
54+
## Why is there a maximum version limit?
55+
56+
Most tools only enforce a minimum version. `grz-cli` also enforces an upper bound to prevent untested releases from being used in regulated submission workflows, where the exact toolchain version may need to match what was validated. If you have installed a pre-release or a newer version than your organisation currently supports, downgrade to the approved version before submitting.

0 commit comments

Comments
 (0)