Skip to content

Commit 759de97

Browse files
authored
Merge pull request coder#120 from coder/doc-compatibility-check
doc: Coder version range compatibility check
2 parents d54141b + 0790f1c commit 759de97

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed
32.6 KB
Loading

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,16 @@ versions of Gateway we've decided:
226226
different release channels (ex: `eap` or `beta`), but all of them except the stable channel have to be
227227
manually configured by users in Gateway - which is super inconvenient.
228228

229+
## Supported Coder versions
230+
231+
`Coder Gateway` includes checks for compatibility with a specified version range. A warning is raised when
232+
the Coder deployment build version is outside of compatibility range:
233+
![Compatibility Check with Coder deployment](.github/readme/compatibility_check.png)
234+
235+
The range needs to be manually updated as often as possible. The lowest bound is specified by `minCompatibleCoderVersion`
236+
property in the [CoderSupportedVersions.properties](src/main/resources/version/CoderSupportedVersions.properties)
237+
while `maxCompatibleCoderVersion` specifies the upper bound.
238+
229239
[docs:qodana-github-action]: https://www.jetbrains.com/help/qodana/qodana-intellij-github-action.html
230240

231241
[docs:plugin-signing]: https://plugins.jetbrains.com/docs/intellij/plugin-signing.html?from=IJPluginTemplate

0 commit comments

Comments
 (0)