Skip to content

doc: Coder version range compatibility check #120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 9, 2022
Merged

doc: Coder version range compatibility check #120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .github/readme/compatibility_check.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,16 @@ versions of Gateway we've decided:
different release channels (ex: `eap` or `beta`), but all of them except the stable channel have to be
manually configured by users in Gateway - which is super inconvenient.

## Supported Coder versions

`Coder Gateway` includes checks for compatibility with a specified version range. A warning is raised when
the Coder deployment build version is outside of compatibility range:
![Compatibility Check with Coder deployment](.github/readme/compatibility_check.png)

The range needs to be manually updated as often as possible. The lowest bound is specified by `minCompatibleCoderVersion`
property in the [CoderSupportedVersions.properties](src/main/resources/version/CoderSupportedVersions.properties)
while `maxCompatibleCoderVersion` specifies the upper bound.

[docs:qodana-github-action]: https://www.jetbrains.com/help/qodana/qodana-intellij-github-action.html

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